前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >web3j开发java或android以太坊智能合约快速入门

web3j开发java或android以太坊智能合约快速入门

作者头像
笔阁
发布2018-09-04 17:42:01
2.3K0
发布2018-09-04 17:42:01
举报
文章被收录于专栏:极客编程极客编程

web3j简介

web3j是一个轻量级、高度模块化、响应式、类型安全的Java和Android类库提供丰富API,用于处理以太坊智能合约及与以太坊网络上的客户端(节点)进行集成。

可以通过它进行以太坊区块链的开发,而无需为你的应用平台编写集成代码。

可以快速启动dmeo示例

想要快速启动的话,有一个Web3j demo示例项目可用,演示了通过Web3j开发以太坊的许多核心特征,其中包括:

  • 连接到以太网网络上的节点
  • 加载一个以太坊钱包文件
  • 将以太币从一个地址发送到另一个地址
  • 向网络部署智能合约
  • 从部署的智能合约中读取值
  • 更新部署的智能合约中的值
  • 查看由智能合约记录的事件

web3j开发入门

首先将最新版本的web3j安装到项目中。

Maven

Java 8:

代码语言:javascript
复制
<dependency>
  <groupId>org.web3j</groupId>
  <artifactId>core</artifactId>
  <version>3.4.0</version>
</dependency>

Android:

代码语言:javascript
复制
<dependency>
  <groupId>org.web3j</groupId>
  <artifactId>core</artifactId>
  <version>3.3.1-android</version>
</dependency>

Gradle

Java 8:

代码语言:javascript
复制
compile ('org.web3j:core:3.4.0')

Android:

代码语言:javascript
复制
compile ('org.web3j:core:3.3.1-android')

启动客户端

需要启动一个以太坊客户端,当然如果你已经启动了就不需要再次启动。

如果是geth的话这么启动:

代码语言:javascript
复制
$ geth --rpcapi personal,db,eth,net,web3 --rpc --rinkeby

如果是Parity启动:

代码语言:javascript
复制
$ parity --chain testnet

如果使用Infura客户端提供的免费的云端服务,这么启动:

代码语言:javascript
复制
Web3j web3 = Web3j.build(new HttpService("https://morden.infura.io/your-token"));

如果想进一步的了解infura,请参阅Using Infura with web3j

在网络上如何获得以太币的相关文档可以看这个:testnet section of the docs

当不需要Web3j实例时,需要调用shutdown方法来释放它所使用的资源。

代码语言:javascript
复制
web3.shutdown()

发送请求

发送同步请求

代码语言:javascript
复制
Web3j web3 = Web3j.build(new HttpService());  // defaults to http://localhost:8545/
Web3ClientVersion web3ClientVersion = web3.web3ClientVersion().send();
String clientVersion = web3ClientVersion.getWeb3ClientVersion();

** 使用CompletableFuture (Future on Android) 发送异步请求**

代码语言:javascript
复制
Web3j web3 = Web3j.build(new HttpService());  // defaults to http://localhost:8545/
Web3ClientVersion web3ClientVersion = web3.web3ClientVersion().sendAsync().get();
String clientVersion = web3ClientVersion.getWeb3ClientVersion();

*使用RxJava的Observable

代码语言:javascript
复制
Web3j web3 = Web3j.build(new HttpService());  // defaults to http://localhost:8545/
web3.web3ClientVersion().observable().subscribe(x -> {
    String clientVersion = x.getWeb3ClientVersion();
    ...
});

注意Android使用方式

代码语言:javascript
复制
Web3j web3 = Web3jFactory.build(new HttpService());  // defaults to http://localhost:8545/
...

IPC

Web3j还支持通过文件套接字快速运行进程间通信(IPC),支持客户端在相同的主机上同时运行Web3j。在创建服务时,使用相关的IPCService就可以实现而不需要通过HTTPService

代码语言:javascript
复制
// 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的情况下进行以太坊智能合同部署和交互。

要打包代码,需要先编译智能合同:

代码语言:javascript
复制
$ solc <contract>.sol --bin --abi --optimize -o <output-dir>/

然后用web3j的命令行工具打包代码:

代码语言:javascript
复制
web3j solidity generate /path/to/<smart-contract>.bin /path/to/<smart-contract>.abi -o /path/to/src/main/java -p com.your.organisation.name

接下来就可以新建和部署智能合约了:

代码语言:javascript
复制
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

或者使用一个现有的智能合约:

代码语言:javascript
复制
YourSmartContract contract = YourSmartContract.load(
        "0x<address>|<ensName>", <web3j>, <credentials>, GAS_PRICE, GAS_LIMIT);

然后就可以进行智能合约的交互了:

代码语言:javascript
复制
TransactionReceipt transactionReceipt = contract.someMethod(
             <param1>,
             ...).send();

调用智能合约:

代码语言:javascript
复制
Type result = contract.someMethod(<param1>, ...).send();

更多关于打包的资料可以看这里:Solidity smart contract wrappers

Filters

web3j的响应式函数可以使观察者通过事件去通知消息订阅者变得很简单,并能够记录在区块链中。接收所有新的区块并把它们添加到区块链中:

代码语言:javascript
复制
Subscription subscription = web3j.blockObservable(false).subscribe(block -> {
    ...
});

接收所有新的交易并把它们添加到区块链中:

代码语言:javascript
复制
Subscription subscription = web3j.transactionObservable().subscribe(tx -> {
    ...
});

接收所有已经提交到网络中等待处理的交易。(他们被统一的分配到一个区块之前。)

代码语言:javascript
复制
Subscription subscription = web3j.pendingTransactionObservable().subscribe(tx -> {
    ...
});

或者你重置所有的区块到最新的位置,那么当有新建区块的时候会通知你。

代码语言:javascript
复制
Subscription subscription = catchUpToLatestAndSubscribeToNewBlocksObservable(
        <startBlockNumber>, <fullTxObjects>)
        .subscribe(block -> {
            ...
});

主题过滤也被支持:

代码语言:javascript
复制
EthFilter filter = new EthFilter(DefaultBlockParameterName.EARLIEST,
        DefaultBlockParameterName.LATEST, <contract-address>)
             .addSingleTopic(...)|.addOptionalTopics(..., ...)|...;
web3j.ethLogObservable(filter).subscribe(log -> {
    ...
});

当不再需要时,订阅也应该被取消:

代码语言:javascript
复制
subscription.unsubscribe();

**注意:Infura中不支持filters。 **

需要了解更多有关过滤器和事件的信息可以查看Filters and EventsWeb3jRx的接口。

交易

Web3j支持使用以太坊钱包文件(推荐的)和用于发送事务的以太坊客户端管理命令。

使用以太钱包文件发送以太币给其他人:

代码语言:javascript
复制
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();

或者你希望建立你自己定制的交易:

代码语言:javascript
复制
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的Transfer进行以太币交易要简单得多。

使用以太坊客户端的管理命令(如果你的钱包密钥已经在客户端存储):

代码语言:javascript
复制
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
}

如果你想使用 Parity’s Personal 或者 Trace 功能, 或者 Geth’s Personal 客户端 APIs,可以使用org.web3j:parityorg.web3j:geth模块。

命令行工具

web3j的jar包为每一个版本都提供命令行工具。命令行工具允许你直接通过一些命令使用web3j的一些功能:

  • 钱包创建
  • 钱包密码管理
  • 资金从钱包转移到另一个
  • solidity编写的智能合同功能打包

请参阅文档以获得命令行相关的进一步的信息。

其他的细节

java8 bulid:

  • Web3j提供对所有响应类型的安全访问。可选的或null响应java 8都支持。
  • 异步请求包在一个java 8的CompletableFutures。Web3j提供了围绕所有异步请求的打包工具,以确保在执行期间可以捕获任何异常,而不只是丢弃。由于在完全检查中会有很多缺少支持的异常情况,这些异常通常被确定为未检测到的异常,导致检测过程出现问题。有关详细信息,请参见 Async.run()及其关联 test

在java 8的Android版本:

  • 包数量作为 BigIntegers返回。对于简单的结果,可以通过Response.getResult()获取字符串类型的数量结果。
  • 还可以通过在 HttpService和IpcService类中存在的includeRawResponse参数将原生的JSON包放置在响应中。

  • Web3j教程,主要介绍java和android app通过web3j进行区块链以太坊开发,适合java和android程序员。
  • 以太坊教程,主要介绍智能合约与dapp应用开发,适合入门。
  • 以太坊开发,主要是介绍使用node.js、mongodb、区块链、ipfs实现去中心化电商DApp实战,适合进阶。

汇智网原创翻译,转载请标明出处,官方原文web3j

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • web3j简介
  • 可以快速启动dmeo示例
  • web3j开发入门
    • Maven
      • Gradle
        • 启动客户端
          • 发送请求
            • IPC
              • 通过java打包以太坊智能合约
                • Filters
                  • 交易
                    • 命令行工具
                      • 其他的细节
                      相关产品与服务
                      命令行工具
                      腾讯云命令行工具 TCCLI 是管理腾讯云资源的统一工具。使用腾讯云命令行工具,您可以快速调用腾讯云 API 来管理您的腾讯云资源。此外,您还可以基于腾讯云的命令行工具来做自动化和脚本处理,以更多样的方式进行组合和重用。
                      领券
                      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档