# WeCross-Java-SDK

**Repository Path**: WeBank/WeCross-Java-SDK

## Basic Information

- **Project Name**: WeCross-Java-SDK
- **Description**: WeCross-Java-SDK为WeCross提供Java API。开发者通过SDK可以方便快捷地基于WeCross开发自己的跨链应用
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 16
- **Forks**: 4
- **Created**: 2020-03-17
- **Last Updated**: 2025-06-15

## Categories & Tags

**Categories**: blockchain

**Tags**: None

## README

![](docs/images/menu_logo_wecross.png)

# WeCross-Java-SDK

[![CodeFactor](https://www.codefactor.io/repository/github/webankblockchain/wecross-Java-SDK/badge)](https://www.codefactor.io/repository/github/webankblockchain/wecross-Java-SDK) [![Build Status](https://travis-ci.org/WeBankBlockchain/WeCross-Java-SDK.svg?branch=master)](https://travis-ci.org/WeBankBlockchain/WeCross-Java-SDK) [![codecov](https://codecov.io/gh/WeBankBlockchain/WeCross-Java-SDK/branch/dev/graph/badge.svg)](https://codecov.io/gh/WeBankBlockchain/WeCross-Java-SDK) [![Latest release](https://img.shields.io/github/release/WeBankBlockchain/WeCross-Java-SDK.svg)](https://github.com/WeBankFnTech/WeCross-Java-SDK/releases/latest)
[![Maven Central](https://img.shields.io/maven-central/v/com.webank/wecross-java-sdk)](https://search.maven.org/artifact/com.webank/wecross-java-sdk) [![License](https://img.shields.io/github/license/WeBankBlockchain/WeCross-Java-SDK)](https://www.apache.org/licenses/LICENSE-2.0) [![Language](https://img.shields.io/badge/Language-Java-blue.svg)](https://www.java.com)

WeCross Java SDK提供操作跨链资源的Java API，开发者通过SDK可以方便快捷地基于[WeCross](https://github.com/WeBankBlockchain/WeCross)开发自己的跨链应用。

## 关键特性

- 提供调用WeCross[RPC接口](https://wecross.readthedocs.io/zh_CN/latest/docs/manual/api.html)的Java API
- 封装了跨链资源操作接口

## 使用SDK

gradle

```
compile ('com.webank:wecross-java-sdk:1.4.0')
```

maven

```
<dependency>
    <groupId>com.webank</groupId>
    <artifactId>wecross-java-sdk</artifactId>
    <version>1.2.1</version>
</dependency>
```

更多配置及使用教程请参照[SDK技术文档](https://wecross.readthedocs.io/zh_CN/latest/docs/dev/sdk.html)

## 源码编译

**环境要求**:

  - [JDK8及以上](https://www.oracle.com/java/technologies/javase-downloads.html)
  - Gradle 5.0及以上

**编译命令**:

```shell
$ cd WeCross-Java-SDK
$ ./gradlew assemble
```

如果编译成功，将在当前目录的dist/apps目录下生成sdk jar包。

## 项目贡献

欢迎参与WeCross社区的维护和建设：

- 提交代码(Pull requests)，可参考[代码贡献流程](CONTRIBUTING.md)以及[wiki指南](https://github.com/WeBankBlockchain/WeCross/wiki/%E8%B4%A1%E7%8C%AE%E4%BB%A3%E7%A0%81)
- [提问和提交BUG](https://github.com/WeBankBlockchain/WeCross/issues/new)

您将成为贡献者，感谢各位贡献者的付出：

<img src="https://contrib.rocks/image?repo=WeBankBlockchain/WeCross-Java-SDK" alt="https://github.com/WeBankBlockchain/WeCross-Java-SDK/graphs/contributors" style="zoom:100%;" />

## 开源社区

参与meetup：[活动日历](https://github.com/WeBankBlockchain/WeCross/wiki#%E6%B4%BB%E5%8A%A8%E6%97%A5%E5%8E%86)

学习知识、讨论方案、开发新特性：[联系微信小助手，加入跨链兴趣小组（CC-SIG）](https://wecross.readthedocs.io/zh_CN/latest/docs/community/cc-sig.html#id3)

## License

WeCross Java SDK的开源协议为Apache License 2.0，详情参考[LICENSE](./LICENSE)。