# bds-xlm

**Repository Path**: jdcloud-bds/bds-xlm

## Basic Information

- **Project Name**: bds-xlm
- **Description**: 将 XLM 区块链数据同步到消息队列中，供上游服务消费
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://bds.jdcloud.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-09-12
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# bds-xlm
![logo](./docs/bds-logo.png)
## 介绍
bds-xlm 是开源项目区块链数据服务（BDS）的其中一个独立模块 - 提供全节点数据推送服务。

*bds-xlm* 基于 [stellar/go](https://github.com/stellar/go) 的 horizon-v0.22.1 版本进行二次开发，支持直接将新增的区块数据往消息中间件服务 kafka 发送，方便上游的服务来订阅消费。在运行horizon之前需要参照[stellar/core](https://github.com/stellar/stellar-core) v12.1.0进行编译安装。

## 架构
![架构](./docs/bds-architecture.jpg)

## 环境部署 
### 安装 BDS-XLM
#### 环境初始化
[build-unix](./docs/build.md)

#### 运行步骤

1.编译

 ```
   dep ensure -v
   go build -v $GOPATH/src/github.com/stellar/go/services/horizon
 ```
 
2.运行全节点，并支持向 kafka 发送消息

```
  ./horizon --ingest --port <port> --kafka=true --kafka-proxy-host=<kafka host> --kafka-proxy-port=<kafka port> --kafka-topic=<kafka topic>
```

### 安装 confluent 和 kafka
#### 安装kafka
参见 [kafka 官网](http://kafka.apache.org/quickstart)

修改 config/server.properties 文件

* message.max.bytes=1048576000

#### 安装 confluent
参见 [confluent](https://docs.confluent.io/current/installation/installing_cp/zip-tar.html#prod-kafka-cli-install)

解压缩 confluent 安装包并运行Confluent Rest Proxy

修改 /etc/kafka-rest/kafka-rest.properties 文件

* max.request.size = 1048576000
* buffer.memory = 1048576000
* send.buffer.bytes = 1048576000

### 安装 BDS
参见[BDS](https://github.com/jdcloud-bds/bds)

### 数据库
我们现在支持 SQL server 和 PostgreSQL 两种数据库，您可以选择其中一种作为数据存储方法。

#### SQL Server
购买 [云数据库 SQL Server](https://www.jdcloud.com/cn/products/jcs-for-sql-server)

#### PostgreSQL 
购买 [云数据库 PostgreSQL](https://www.jdcloud.com/cn/products/jcs-for-postgresql)

### 安装 Grafana 
参见 [Grafana 官网](https://grafana.com/)

## 新增功能

1. 增加了向 kafka 发送消息的新功能（每次一个新块被全节点同步时，该块的数据将以定制的数据结构被发送到 kafka 中）
2. sendblock 和 sendbatchblock 是新添加的两个 RPC 接口，用于触发全节点发送特定块的数据。

### 源代码修改历史记录
[bds-xlm](./CHANGE_HISTORY.md)

## 贡献
[贡献指南](./CONTRIBUTING.md)

## 开源许可 
[Apache License 2.0](./LICENSE)

## 项目展示
[区块链数据服务](https://bds.jdcloud.com/)