Skip to content

Commit

Permalink
增加英文版文档
Browse files Browse the repository at this point in the history
  • Loading branch information
ZhangYiQiu committed Sep 30, 2022
1 parent d9fa11b commit 5230f68
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@
<a href="https://www.php.net/releases/7_4_0.php"><img src="https://img.shields.io/badge/.NET-6-orange" alt=".net6"></a>
<a href="https://github.com/assimon/dujiaoka/releases/tag/1.0.0"><img src="https://img.shields.io/badge/version-1.0.0-red" alt="version 1.0.0"></a>
</p>
<h2 align="center">简体中文 | <a href="README_EN.md">English</a></h2>

## TokenPay - `USDT-TRC20``TRX` 动态收款地址解决方案
## TokenPay - `区块链`支付解决方案

>一款开源`USDT-TRC20``TRX`动态收款地址的解决方案
>一款开源的,支持以动态收款地址或静态收款地址收取`TRX``USDT-TRC20``ETH``USDT-ERC20``USDC-ERC20`等区块链代币的支付解决方案
## 项目简介
- `TokenPay`是一个由`C#语言`编写的私有化部署`USDT-TRC20``TRX`收款解决方案
- `TokenPay`是一个由`C#语言`编写的私有化部署的`区块链`支付解决方案
- 本项目不依赖任何外部资源,无需另外部署`数据库`,采用轻量化的`sqlite`,也无需`redis`
- 任意项目都可以对接,轻松实现`USDT-TRC20``TRX`收款!😊 😊 😊
- 任意项目都可以对接,轻松实现`TRX``USDT-TRC20``ETH``USDT-ERC20``USDC-ERC20`收款!😊 😊 😊
- `TokenPay` 遵守 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 开源协议!

## 项目特点
Expand Down Expand Up @@ -46,13 +47,13 @@ TokenPay
- `TokenPay`交流群组[https://t.me/TokenPayGroup](https://t.me/TokenPayGroup)

## 设计实现
`TokenPay`的实现方式与其他项目原理类似,都是通过`TronGrid`提供的api节点
轮询有订单的钱包地址的`USDT`代币、`TRX`入账事件,将入账金额,与数据库的订单金额进行对比,若一致,则视为订单完成
`TokenPay`的实现方式与其他项目原理类似,都是通过`TronGrid``EtherScan`等提供的api
轮询订单未过期的钱包地址的`TRX``ETH``USDT``USDC`入账事件,将入账金额,与数据库的订单金额进行对比,若一致,则视为订单完成
```
简单的原理:
0.服务器定时同步交易所最新汇率
1.客户支付,交易上链
2.服务器定时通过API轮询,获取监听地址下的最新`USDT`代币、`TRX`入账交易,并与数据库订单对比
2.服务器定时通过API轮询,获取监听地址下的最新入账交易数据,并与数据库订单对比
3.若金额一致,将订单标记为完成
4.订单完成后,异步通知任务将订单完成事件回调给平台
```
Expand All @@ -73,7 +74,9 @@ USDT-TRC20打赏地址: TQWM6cuy6YesssqqzSucoUkS1A11kAAAAA

[Flurl](https://github.com/tmenier/Flurl) ![Github stars](https://img.shields.io/github/stars/tmenier/Flurl?style=social)

[HDWallet](https://github.com/farukterzioglu/HDWallet) ![Github stars](https://github.com/farukterzioglu/HDWallet?style=social)
[Nethereum](https://github.com/Nethereum/Nethereum) ![Github stars](https://img.shields.io/github/stars/Nethereum/Nethereum?style=social)

[HDWallet](https://github.com/farukterzioglu/HDWallet) ![Github stars](https://img.shields.io/github/stars/farukterzioglu/HDWallet?style=social)

## 声明
`TokenPay`为开源的产品,仅用于学习交流使用!
Expand Down
92 changes: 92 additions & 0 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# TokenPay
<p>
<a href="https://www.gnu.org/licenses/gpl-3.0.html"><img src="https://img.shields.io/badge/license-GPLV3-blue" alt="license GPLV3"></a>
<a href="https://www.php.net/releases/7_4_0.php"><img src="https://img.shields.io/badge/.NET-6-orange" alt=".net6"></a>
<a href="https://github.com/assimon/dujiaoka/releases/tag/1.0.0"><img src="https://img.shields.io/badge/version-1.0.0-red" alt="version 1.0.0"></a>
</p>
<h2 align="center"><a href="README.md">简体中文</a> | English</h2>

## TokenPay - `Blockchain` Payment Solution

>An open source, payment solution that supports receiving `TRX`, `USDT-TRC20`, `ETH`, `USDT-ERC20`, `USDC-ERC20` and other blockchain tokens with dynamic payout addresses or static payout addresses!
## Project Description
- `TokenPay` is a privately deployed `blockchain` payment solution written in `C# language`.
- The project does not depend on any external resources, no need to deploy a separate `database`, uses lightweight `sqlite`, and does not require `redis`.
- Any project can be docked and easily implement `TRX`, `USDT-TRC20`, `ETH`, `USDT-ERC20`, `USDC-ERC20` collections! 😊 😊 😊 😊
- `TokenPay` is licensed under the terms of the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) license.

## Project Features
- `C# language` cross-platform implementation, support x86 and arm chip architecture win/linux/mac devices😁
- Support one collection address per order, or one collection address per user, solving the pain point of single address collection, which easily leads to wrong order completion.
- No additional environment configuration, just run a compiled binary file to use

## Project Structure
```
TokenPay
├── Plugs ---> (Plug-in)
├── Wiki ---> (Wiki)
└── src ---> (Core)
```
## Available plug-ins
- [dujiaoka](Plugs/dujiaoka/) | [dujiaoka](https://github.com/assimon/dujiaoka) ![Github stars](https://img.shields.io/github/stars/assimon/dujiaoka?style=social)
- [v2board](Plugs/v2board/) | [v2board](https://github.com/v2board/v2board) ![Github stars](https://img.shields.io/github/stars/v2board/v2board?style=social)
- [card-system](Plugs/card-system/) | [card-system](https://github.com/Tai7sy/card-system) ![Github stars](https://img.shields.io/github/stars/Tai7sy/card-system?style=social)

## System Api(Only Chinese)
- `TokenPay`Api Docs👉🏻[TokenPay Api Docs](Wiki/docs.md)
- **Also refer to the existing plugins in the repository**

## Tutorials(Only Chinese):
- Run `TokenPay` Tutorial with aaPanel 👉🏻[aaPanel Tutorial](Wiki/BT_RUN.md)
- Run `TokenPay` tutorial manually👉🏻[Manually Tutorial](Wiki/manual_RUN.md)


## Join the exchange / feedback
- `TokenPay`Channel[https://t.me/TokenPayChannel](https://t.me/TokenPayChannel)
- `TokenPay`Chat[https://t.me/TokenPayGroup](https://t.me/TokenPayGroup)

## Design Implementation
The implementation of `TokenPay` is similar to the principle of other projects, it is through the api provided by `TronGrid`, `EtherScan`, etc.
Poll the `TRX`, `ETH`, `USDT`, `USDC` entry events of the unexpired wallet address of the order, compare the entry amount with the order amount in the database, and if it is the same, the order is considered completed.
```
Simple principle.
0. The server synchronizes the latest exchange rate of the exchange at regular intervals
1. Customers make payments and transactions are uploaded to the chain
2. The server regularly polls through the API to get the latest recorded transaction data under the listening address, and compares it with the database orders
3. If the amount is the same, the order will be marked as completed
4. After the order is completed, the asynchronous notification task will call back the order completion event to the platform
```

## Donate
If this project has helped you, I hope you can buy me a cup of coffee☕️
```
USDT-TRC20: TQWM6cuy6YesssqqzSucoUkS1A11kAAAAA
```
<img src="Wiki/imgs/usdt_thanks_en.jpg" width = "400" alt="usdt扫码打赏"/>

## Thanks
Thanks to the following open source projects.

[Serilog](https://github.com/serilog/serilog) ![Github stars](https://img.shields.io/github/stars/serilog/serilog?style=social)

[FreeSql](https://github.com/dotnetcore/FreeSql) ![Github stars](https://img.shields.io/github/stars/dotnetcore/FreeSql?style=social)

[Flurl](https://github.com/tmenier/Flurl) ![Github stars](https://img.shields.io/github/stars/tmenier/Flurl?style=social)

[Nethereum](https://github.com/Nethereum/Nethereum) ![Github stars](https://img.shields.io/github/stars/Nethereum/Nethereum?style=social)

[HDWallet](https://github.com/farukterzioglu/HDWallet) ![Github stars](https://img.shields.io/github/stars/farukterzioglu/HDWallet?style=social)

## Disclaimers
`TokenPay` is an open source product and is intended for learning and communication purposes only!
It cannot be used for any purpose that violates the laws and regulations of the People's Republic of China (including Taiwan Province) or the user's region.
Because the author, i.e. myself, only developed the code and open source activities (open source means that anyone can download and use it or modify it for distribution), and never participated in any operation or profit-making activities of the user.
And we do not know what use the user will subsequently use the program source code for, so any legal responsibility brought about by the user's use is the user's own responsibility.
```
!!!Warning!!!
The blockchain tokens involved in the project are for learning purposes, and the author does not endorse the financial attributes of the tokens derived from the blockchain.
We do not encourage and support any illegal behavior such as "mining", "speculation", "virtual coin ICO", etc.
Virtual coin market behavior is not subject to regulatory requirements and control, investment transactions need to be cautious, only for learning blockchain knowledge
```
[![Stargazers over time](https://starchart.cc/LightCountry/TokenPay.svg)](https://starchart.cc/LightCountry/TokenPay)
Binary file added Wiki/imgs/usdt_thanks_en.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5230f68

Please sign in to comment.