wehub-resource-sync
88 lines
4.1 KiB
Markdown
88 lines
4.1 KiB
Markdown
<!-- WEHUB_ZH_README -->
|
||
> [!NOTE]
|
||
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
|
||
> [English](./README.en.md) · [原始项目](https://github.com/trustwallet/assets) · [上游 README](https://github.com/trustwallet/assets/blob/HEAD/README.md)
|
||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||
|
||
# Trust Wallet Assets Info
|
||
|
||
|
||
|
||
## Overview
|
||
|
||
Trust Wallet 代币仓库（token repository）是一份全面、及时更新的加密货币代币信息合集，涵盖数千种（！）代币。
|
||
|
||
[Trust Wallet](https://trustwallet.com) 会使用此来源的代币 logo，同时还有许多其他项目也在使用。
|
||
|
||
该仓库包含多条区块链上的代币信息、dApp 信息、质押验证者（staking validators）信息等。
|
||
对于每种代币，都提供 logo 以及可选的附加信息（此类数据在链上不可用）。
|
||
|
||
如此庞大的合集只能通过社区协作来维护，因此_欢迎添加你的代币_。
|
||
|
||
<center><img src='https://trustwallet.com/assets/images/media/assets/horizontal_blue.png' height="200"></center>
|
||
|
||
## How to add token
|
||
|
||
请注意，__不接受全新代币__，
|
||
项目必须可靠、信息可查，且具备__非最小流通量__
|
||
（限额详情见 <https://developer.trustwallet.com/listing-new-assets/requirements>）。
|
||
|
||
### Assets App
|
||
|
||
[Assets 网页应用](https://assets.trustwallet.com) 可用于大多数新代币的添加（需要 Github 账号）。
|
||
|
||
### Quick starter
|
||
|
||
仓库结构与贡献指南的详细说明见
|
||
[开发者站点](https://developer.trustwallet.com/listing-new-assets/new-asset).
|
||
以下是最常见用例的快速入门摘要。
|
||
|
||
|
||
## Documentation
|
||
|
||
详情请参阅 [开发者站点](https://developer.trustwallet.com):
|
||
|
||
- [贡献指南](https://developer.trustwallet.com/listing-new-assets/repository_details)
|
||
|
||
- [FAQ](https://developer.trustwallet.com/listing-new-assets/faq)
|
||
|
||
## Scripts
|
||
|
||
维护者可使用以下若干脚本：
|
||
|
||
- `make check` -- 执行校验检查；也用于持续集成。
|
||
- `make fix` -- 在可能的情况下执行自动修复
|
||
- `make update-auto` -- 从外部来源运行自动更新，定期执行（GitHub action）
|
||
- `make add-token asset_id=c60_t0x4Fabb145d64652a948d72533023f6E7A623C7C53` -- 创建 `info.json` 文件作为资产模板。
|
||
- `make add-tokenlist asset_id=c60_t0x4Fabb145d64652a948d72533023f6E7A623C7C53` -- 将代币添加到 tokenlist.json。
|
||
- `make add-tokenlist-extended asset_id=c60_t0x4Fabb145d64652a948d72533023f6E7A623C7C53` -- 将代币添加到 tokenlist-extended.json。
|
||
|
||
## On Checks
|
||
|
||
本仓库包含一组用于校验所有信息的脚本。以 Golang 脚本实现，可通过 `make check` 使用，并在 CI 构建中执行；会检查整个仓库。
|
||
还实现了类似的检查逻辑：
|
||
|
||
- 在 assets-management 应用中；用于在 PR 中检查已变更的代币文件，或在创建 PR 时检查。检查 diff，可在浏览器环境中运行。
|
||
- 在 merge-fee-bot 中，作为 GitHub app 运行，在 PR 评论中显示结果。在非浏览器环境中执行。
|
||
|
||
## Trading pair maintenance
|
||
|
||
受支持交易对的信息存储在 `tokenlist.json` 文件中。
|
||
交易对可更新——
|
||
通过 Uniswap/Ethereum 和 PancakeSwap/Smartchain 的更新脚本（并提交变更）。
|
||
交易对纳入的最低限额值在 [配置文件](https://github.com/trustwallet/assets/blob/master/.github/assets.config.yaml). 中设置。
|
||
配置中还提供 force-include 和 force-exclude 选项。
|
||
|
||
## Disclaimer
|
||
|
||
Trust Wallet 团队允许任何人向本仓库提交新资产。但这并不意味着我们与所有项目都建立了直接合作关系。
|
||
|
||
Trust Wallet 团队会在仔细审核后拒绝被认定为诈骗或欺诈的项目。
|
||
Trust Wallet 团队保留随时更改资产提交条款的权利，原因可能包括市场条件变化、欺诈风险，或我们认为相关的任何其他因素。
|
||
|
||
此外，类似垃圾信息的行为，包括但不限于向随机地址大量分发代币，将导致该资产被标记为 spam，并可能被从仓库中移除。
|
||
|
||
## License
|
||
|
||
本项目中的脚本和文档依据 [MIT License](LICENSE) 发布。
|