From 86d17630cd331432a94869cd10fe6b433c908906 Mon Sep 17 00:00:00 2001 From: Tron Date: Mon, 21 Jul 2025 14:01:50 +0800 Subject: [PATCH 1/7] fix some bugs --- docs/dapp/index.en.md | 53 ------------------- docs/dapp/index.zh.md | 53 ------------------- docs/dapp/stake2.en.md | 2 +- docs/dapp/stake2.zh.md | 4 +- docs/javascripts/nav-toc.js | 14 +++++ docs/mobile/asset-management.en.md | 1 - docs/mobile/asset-management.zh.md | 1 - docs/mobile/dapp-support.en.md | 1 - .../dapp-support/integrate-tronlink.en.md | 2 +- docs/mobile/deeplink.en.md | 8 ++- docs/mobile/deeplink.zh.md | 7 ++- docs/mobile/deeplink/callback-codes.en.md | 3 +- docs/mobile/deeplink/callback-codes.zh.md | 1 + docs/mobile/deeplink/login-auth.en.md | 1 - docs/mobile/index.en.md | 35 ------------ docs/mobile/index.zh.md | 35 ------------ docs/overrides/main.html | 32 +++++++++-- .../active-requests/connect-website.en.md | 7 +-- docs/plugin-wallet/index.en.md | 36 ------------- docs/plugin-wallet/index.zh.md | 36 ------------- .../passive-messages/account-change.zh.md | 1 - .../user-active-connect.zh.md | 2 +- docs/stylesheets/extra.css | 44 +++++++++++++++ mkdocs.yml | 8 +-- 24 files changed, 112 insertions(+), 275 deletions(-) delete mode 100644 docs/dapp/index.en.md delete mode 100644 docs/dapp/index.zh.md delete mode 100644 docs/mobile/index.en.md delete mode 100644 docs/mobile/index.zh.md delete mode 100644 docs/plugin-wallet/index.en.md delete mode 100644 docs/plugin-wallet/index.zh.md diff --git a/docs/dapp/index.en.md b/docs/dapp/index.en.md deleted file mode 100644 index 4148688..0000000 --- a/docs/dapp/index.en.md +++ /dev/null @@ -1,53 +0,0 @@ -# DApp 开发指南 - -TronLink 为 DApp 开发者提供了完整的开发工具和 API，支持多签转账、消息签名、普通转账和 Stake2.0 等功能。 - -## 主要功能 - -### 基础功能 -- [开始开发](getting-started.md) - DApp 开发快速开始指南 -- [普通转账](transfer.md) - 基本的转账功能 - -### 高级功能 -- [多签转账](multi-sign-transfer.md) - 多签转账功能实现 -- [消息签名](message-signing.md) - 消息签名功能 -- [Stake2.0](stake2.md) - Stake2.0 功能集成 - -## 开发流程 - -### 1. 环境准备 -- 安装 TronLink 钱包 -- 配置开发环境 -- 准备测试网络 - -### 2. 基础集成 -- 按照 [开始开发](getting-started.md) 进行基础集成 -- 实现基本的转账功能 -- 测试基础功能 - -### 3. 高级功能 -- 根据需求集成多签转账 -- 实现消息签名功能 -- 集成 Stake2.0 功能 - -### 4. 测试和部署 -- 全面测试所有功能 -- 优化用户体验 -- 部署到生产环境 - -## 最佳实践 - -- 始终在测试网络进行充分测试 -- 实现错误处理和用户提示 -- 遵循安全最佳实践 -- 提供清晰的用户界面和操作指引 - -## 技术支持 - -- 参考相关文档进行开发 -- 加入开发者社区获取帮助 -- 联系技术支持团队解决技术问题 - -## 示例代码 - -每个功能模块都提供了详细的示例代码，开发者可以直接参考使用。 \ No newline at end of file diff --git a/docs/dapp/index.zh.md b/docs/dapp/index.zh.md deleted file mode 100644 index 4148688..0000000 --- a/docs/dapp/index.zh.md +++ /dev/null @@ -1,53 +0,0 @@ -# DApp 开发指南 - -TronLink 为 DApp 开发者提供了完整的开发工具和 API，支持多签转账、消息签名、普通转账和 Stake2.0 等功能。 - -## 主要功能 - -### 基础功能 -- [开始开发](getting-started.md) - DApp 开发快速开始指南 -- [普通转账](transfer.md) - 基本的转账功能 - -### 高级功能 -- [多签转账](multi-sign-transfer.md) - 多签转账功能实现 -- [消息签名](message-signing.md) - 消息签名功能 -- [Stake2.0](stake2.md) - Stake2.0 功能集成 - -## 开发流程 - -### 1. 环境准备 -- 安装 TronLink 钱包 -- 配置开发环境 -- 准备测试网络 - -### 2. 基础集成 -- 按照 [开始开发](getting-started.md) 进行基础集成 -- 实现基本的转账功能 -- 测试基础功能 - -### 3. 高级功能 -- 根据需求集成多签转账 -- 实现消息签名功能 -- 集成 Stake2.0 功能 - -### 4. 测试和部署 -- 全面测试所有功能 -- 优化用户体验 -- 部署到生产环境 - -## 最佳实践 - -- 始终在测试网络进行充分测试 -- 实现错误处理和用户提示 -- 遵循安全最佳实践 -- 提供清晰的用户界面和操作指引 - -## 技术支持 - -- 参考相关文档进行开发 -- 加入开发者社区获取帮助 -- 联系技术支持团队解决技术问题 - -## 示例代码 - -每个功能模块都提供了详细的示例代码，开发者可以直接参考使用。 \ No newline at end of file diff --git a/docs/dapp/stake2.en.md b/docs/dapp/stake2.en.md index c7edca0..8634ef8 100644 --- a/docs/dapp/stake2.en.md +++ b/docs/dapp/stake2.en.md @@ -24,5 +24,5 @@ For example: transaction.__options = {"estimatedBandwidth": 1} ``` -The specific calculation logic of estimatedEnergy and estimatedBandwidth can be found in the last chapter of the "[Stake 2.0 Adaptation FAQ](https://coredevs.medium.com/stake-2-0-adaption-faq-66bafdf53606)": "How to convert resource share to amount?" +The specific calculation logic of estimatedEnergy and estimatedBandwidth can be found in the last chapter of the "[Stake 2.0 Adaptation FAQ](https://coredevs.medium.com/stake-2-0-adaption-faq-66bafdf53606)": "How to convert resource share to amount?" diff --git a/docs/dapp/stake2.zh.md b/docs/dapp/stake2.zh.md index 8aa21de..27d20e8 100644 --- a/docs/dapp/stake2.zh.md +++ b/docs/dapp/stake2.zh.md @@ -23,6 +23,4 @@ img { transaction.__options = {"estimatedBandwidth": 1} ``` -estimatedEnergy estimatedBandwidth 的具体计算逻辑见![image](../images/dapp_skake2.0_img_1.png)[Stake 2.0 Adaption FAQ](https://www.google.com/url?q=https://coredevs.medium.com/stake-2-0-adaption-faq-66bafdf53606&sa=D&source=editors&ust=1684151119972747&usg=AOvVaw0msvWulJZhW6xn5QU461cb) 最后一个章节：How to convert resource share to amount? - - +estimatedEnergy estimatedBandwidth 的具体计算逻辑见![image](../images/dapp_skake2.0_img_1.png)[Stake 2.0 Adaptation FAQ](https://www.google.com/url?q=https://coredevs.medium.com/stake-2-0-adaption-faq-66bafdf53606&sa=D&source=editors&ust=1684151119972747&usg=AOvVaw0msvWulJZhW6xn5QU461cb) 最后一个章节：How to convert resource share to amount? diff --git a/docs/javascripts/nav-toc.js b/docs/javascripts/nav-toc.js index 4f49072..a6a10b6 100644 --- a/docs/javascripts/nav-toc.js +++ b/docs/javascripts/nav-toc.js @@ -41,4 +41,18 @@ document.addEventListener("DOMContentLoaded", function () { console.error("tocLink not found"); } } + + + + const header = document.querySelector(".md-header__inner"); // 找到导航容器 + if (header) { + const a1 = document.createElement("a"); + a1.href = "https://www.tronlink.org/"; + a1.target = "_blank"; + a1.className = "md-header__link"; + a1.style="font-size:14px"; + a1.textContent = "Homepage"; + + header.appendChild(a1); + } }); diff --git a/docs/mobile/asset-management.en.md b/docs/mobile/asset-management.en.md index 696d6f9..6ea970b 100644 --- a/docs/mobile/asset-management.en.md +++ b/docs/mobile/asset-management.en.md @@ -1,4 +1,3 @@ - # Asset Management
diff --git a/docs/mobile/asset-management.zh.md b/docs/mobile/asset-management.zh.md index c39de4c..0de0712 100644 --- a/docs/mobile/asset-management.zh.md +++ b/docs/mobile/asset-management.zh.md @@ -1,4 +1,3 @@ - # 资产管理 管理您的资产，并支持自定义通证 diff --git a/docs/mobile/dapp-support.en.md b/docs/mobile/dapp-support.en.md index f40dfb1..dae2cc1 100644 --- a/docs/mobile/dapp-support.en.md +++ b/docs/mobile/dapp-support.en.md @@ -1,4 +1,3 @@ - # DApp Support
diff --git a/docs/mobile/dapp-support/integrate-tronlink.en.md b/docs/mobile/dapp-support/integrate-tronlink.en.md index 74abe72..88cbfb7 100644 --- a/docs/mobile/dapp-support/integrate-tronlink.en.md +++ b/docs/mobile/dapp-support/integrate-tronlink.en.md @@ -2,4 +2,4 @@ TronLink injects a version of TronWeb into the DApp that runs in TronLink's DApp Explorer. This enables the DApp to interact with TronLink DApps and the TRON network. -Details: Go to DApp +Details: [Go to DApp](../../dapp/getting-started.en.md) diff --git a/docs/mobile/deeplink.en.md b/docs/mobile/deeplink.en.md index 9b8aa9b..6724bb2 100644 --- a/docs/mobile/deeplink.en.md +++ b/docs/mobile/deeplink.en.md @@ -4,7 +4,13 @@ DApps and H5 pages can launch the TronLink App to open the wallet, log in, make ![image](../images/tronlink-app_deeplink_img_0.jpg) + + Process Flowchart -Please be aware that only dApps that have been added to the whitelist will be able to establish a successful connection with TronLink. Kindly fill out the whitelist request form here: [Start](https://docs.google.com/forms/d/e/1FAIpQLSdFmYGxVZzwCSsvmdOTq064sxWD22STYth1g5GO5zn3OrB5Jw/viewform?usp=sf_link) +Please be aware that only DApps that have been added to the whitelist will be able to establish a successful connection with TronLink. Kindly fill out the whitelist request form here: [Start](https://docs.google.com/forms/d/e/1FAIpQLSdFmYGxVZzwCSsvmdOTq064sxWD22STYth1g5GO5zn3OrB5Jw/viewform?usp=sf_link) diff --git a/docs/mobile/deeplink.zh.md b/docs/mobile/deeplink.zh.md index 9a3e92c..93ad5cb 100644 --- a/docs/mobile/deeplink.zh.md +++ b/docs/mobile/deeplink.zh.md @@ -3,9 +3,14 @@ DApp、H5应用可以使用 DeepLink 方式拉起 TronLink App 进行打开钱包，登录，转账，签名交易，字符串签名，在钱包中打开 DApp 等操作。 ![image](../images/zh_yi-dong-duan_deeplink_img_0.jpg) + 操作流程图 -注意：只有已添加至白名单的 dApp 才能成功连接至 TronLink。请在此处填写白名单申请：[填写表单](https://docs.google.com/forms/d/e/1FAIpQLSdFmYGxVZzwCSsvmdOTq064sxWD22STYth1g5GO5zn3OrB5Jw/viewform?usp=sf_link) +注意：只有已添加至白名单的 DApp 才能成功连接至 TronLink。请在此处填写白名单申请：[填写表单](https://docs.google.com/forms/d/e/1FAIpQLSdFmYGxVZzwCSsvmdOTq064sxWD22STYth1g5GO5zn3OrB5Jw/viewform?usp=sf_link) diff --git a/docs/mobile/deeplink/callback-codes.en.md b/docs/mobile/deeplink/callback-codes.en.md index a267282..7e217ba 100644 --- a/docs/mobile/deeplink/callback-codes.en.md +++ b/docs/mobile/deeplink/callback-codes.en.md @@ -1,7 +1,8 @@ # Result Code -| 0 | success | | +| id | Message | | |:-------|:-------|:-------| +| 0 | success | | | 10001 | Incorrect JSON format | | | 10002 | Missing Action | | | 10003 | Unknown Action | | diff --git a/docs/mobile/deeplink/callback-codes.zh.md b/docs/mobile/deeplink/callback-codes.zh.md index d7fe1da..3644e9b 100644 --- a/docs/mobile/deeplink/callback-codes.zh.md +++ b/docs/mobile/deeplink/callback-codes.zh.md @@ -2,6 +2,7 @@ | id | 消息 | 备注 | |:-------|:-------|:-------| +| 0 | success | | | 10001 | Incorrect JSON format | | | 10002 | Missing Action | | | 10003 | Unknown Action | | diff --git a/docs/mobile/deeplink/login-auth.en.md b/docs/mobile/deeplink/login-auth.en.md index 49dc0e8..625ae99 100644 --- a/docs/mobile/deeplink/login-auth.en.md +++ b/docs/mobile/deeplink/login-auth.en.md @@ -1,4 +1,3 @@ - # Login by TronLink ```shell diff --git a/docs/mobile/index.en.md b/docs/mobile/index.en.md deleted file mode 100644 index 5833969..0000000 --- a/docs/mobile/index.en.md +++ /dev/null @@ -1,35 +0,0 @@ -# 移动端开发 - -TronLink 移动端提供了完整的开发者集成方案，包括资产管理、DeepLink 集成和 DApp 浏览器支持。 - -## 主要功能 - -### 资产管理 -- [资产管理概述](asset-management.md) - 了解如何在移动端管理资产 -- [自定义通证](asset-management/custom-tokens.md) - 添加和管理自定义通证 - -### DeepLink 集成 -- [DeepLink 概述](deeplink.md) - DeepLink 功能总览 -- [打开钱包](deeplink/open-wallet.md) - 通过 DeepLink 打开钱包 -- [打开DApp](deeplink/open-dapp.md) - 通过 DeepLink 打开 DApp -- [登陆授权](deeplink/login-auth.md) - 用户登录和授权 -- [转账](deeplink/transfer.md) - 通过 DeepLink 进行转账 -- [交易签名](deeplink/transaction-signing.md) - 交易签名功能 -- [消息签名](deeplink/message-signing.md) - 消息签名功能 -- [回传消息码](deeplink/callback-codes.md) - 回传消息码说明 - -### DApp 支持 -- [DApp 支持概述](dapp-support.md) - DApp 集成总览 -- [集成TronLink](dapp-support/integrate-tronlink.md) - 如何集成 TronLink -- [DApp浏览器](dapp-support/dapp-browser.md) - DApp 浏览器功能 - -## 快速开始 - -1. 阅读 [DeepLink 概述](deeplink.md) 了解基本概念 -2. 按照 [集成TronLink](dapp-support/integrate-tronlink.md) 进行集成 -3. 测试各种功能，确保正常工作 -4. 参考示例代码进行开发 - -## 技术支持 - -如有问题，请参考相关文档或联系技术支持团队。 \ No newline at end of file diff --git a/docs/mobile/index.zh.md b/docs/mobile/index.zh.md deleted file mode 100644 index 5833969..0000000 --- a/docs/mobile/index.zh.md +++ /dev/null @@ -1,35 +0,0 @@ -# 移动端开发 - -TronLink 移动端提供了完整的开发者集成方案，包括资产管理、DeepLink 集成和 DApp 浏览器支持。 - -## 主要功能 - -### 资产管理 -- [资产管理概述](asset-management.md) - 了解如何在移动端管理资产 -- [自定义通证](asset-management/custom-tokens.md) - 添加和管理自定义通证 - -### DeepLink 集成 -- [DeepLink 概述](deeplink.md) - DeepLink 功能总览 -- [打开钱包](deeplink/open-wallet.md) - 通过 DeepLink 打开钱包 -- [打开DApp](deeplink/open-dapp.md) - 通过 DeepLink 打开 DApp -- [登陆授权](deeplink/login-auth.md) - 用户登录和授权 -- [转账](deeplink/transfer.md) - 通过 DeepLink 进行转账 -- [交易签名](deeplink/transaction-signing.md) - 交易签名功能 -- [消息签名](deeplink/message-signing.md) - 消息签名功能 -- [回传消息码](deeplink/callback-codes.md) - 回传消息码说明 - -### DApp 支持 -- [DApp 支持概述](dapp-support.md) - DApp 集成总览 -- [集成TronLink](dapp-support/integrate-tronlink.md) - 如何集成 TronLink -- [DApp浏览器](dapp-support/dapp-browser.md) - DApp 浏览器功能 - -## 快速开始 - -1. 阅读 [DeepLink 概述](deeplink.md) 了解基本概念 -2. 按照 [集成TronLink](dapp-support/integrate-tronlink.md) 进行集成 -3. 测试各种功能，确保正常工作 -4. 参考示例代码进行开发 - -## 技术支持 - -如有问题，请参考相关文档或联系技术支持团队。 \ No newline at end of file diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 741d688..432b375 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -9,13 +9,37 @@
{% if page.previous_page %} - - ← {{ page.previous_page.title }} + {% set direction = lang.t("footer.previous") %} + +
+ {% set icon = config.theme.icon.previous or "material/arrow-left" %} + {% include ".icons/" ~ icon ~ ".svg" %} +
+
+ + {{ direction }} + +
+ {{ page.previous_page.title }} +
+
{% endif %} {% if page.next_page %} - - {{ page.next_page.title }} → + {% set direction = lang.t("footer.next") %} + +
+ + {{ direction }} + +
+ {{ page.next_page.title }} +
+
+
+ {% set icon = config.theme.icon.next or "material/arrow-right" %} + {% include ".icons/" ~ icon ~ ".svg" %} +
{% endif %}
diff --git a/docs/plugin-wallet/active-requests/connect-website.en.md b/docs/plugin-wallet/active-requests/connect-website.en.md index 1183d09..7e617a6 100644 --- a/docs/plugin-wallet/active-requests/connect-website.en.md +++ b/docs/plugin-wallet/active-requests/connect-website.en.md @@ -28,18 +28,15 @@ TronLink supports TRX transfers, contract signature, authorization, etc. initiat **Parameters** ```shell - - interface RequestAccountsParams { websiteIcon?: string; websiteName?: string; } -`` +``` + **Returns** ```shell - - interface ReqestAccountsResponse { code: 200 | 4000 | 4001, message: string diff --git a/docs/plugin-wallet/index.en.md b/docs/plugin-wallet/index.en.md deleted file mode 100644 index fc8e889..0000000 --- a/docs/plugin-wallet/index.en.md +++ /dev/null @@ -1,36 +0,0 @@ -# 插件钱包开发 - -TronLink 插件钱包为浏览器环境提供了完整的开发者集成方案，支持主动请求功能和被动消息接收。 - -## 主要功能 - -### 主动请求功能 -- [主动请求概述](active-requests.md) - 主动请求功能总览 -- [连接网站](active-requests/connect-website.md) - 连接网站功能 -- [添加Token](active-requests/add-token.md) - 添加 Token 功能 - -### 被动接收消息 -- [被动消息概述](passive-messages.md) - 被动接收消息总览 -- [账户改变消息](passive-messages/account-change.md) - 账户改变消息处理 -- [网络改变消息](passive-messages/network-change.md) - 网络改变消息处理 -- [连接网站成功消息](passive-messages/connect-success.md) - 连接成功消息处理 -- [断开连接网站消息](passive-messages/disconnect.md) - 断开连接消息处理 -- [即将废弃的消息](passive-messages/deprecated-messages.md) - 即将废弃的消息说明 - -## 快速开始 - -1. 阅读 [主动请求概述](active-requests.md) 了解基本概念 -2. 按照 [连接网站](active-requests/connect-website.md) 进行集成 -3. 实现 [被动消息处理](passive-messages.md) 功能 -4. 测试各种功能，确保正常工作 - -## 开发注意事项 - -- 确保正确处理所有消息类型 -- 注意即将废弃的消息，及时更新代码 -- 遵循安全最佳实践 -- 测试不同网络环境下的兼容性 - -## 技术支持 - -如有问题，请参考相关文档或联系技术支持团队。 \ No newline at end of file diff --git a/docs/plugin-wallet/index.zh.md b/docs/plugin-wallet/index.zh.md deleted file mode 100644 index fc8e889..0000000 --- a/docs/plugin-wallet/index.zh.md +++ /dev/null @@ -1,36 +0,0 @@ -# 插件钱包开发 - -TronLink 插件钱包为浏览器环境提供了完整的开发者集成方案，支持主动请求功能和被动消息接收。 - -## 主要功能 - -### 主动请求功能 -- [主动请求概述](active-requests.md) - 主动请求功能总览 -- [连接网站](active-requests/connect-website.md) - 连接网站功能 -- [添加Token](active-requests/add-token.md) - 添加 Token 功能 - -### 被动接收消息 -- [被动消息概述](passive-messages.md) - 被动接收消息总览 -- [账户改变消息](passive-messages/account-change.md) - 账户改变消息处理 -- [网络改变消息](passive-messages/network-change.md) - 网络改变消息处理 -- [连接网站成功消息](passive-messages/connect-success.md) - 连接成功消息处理 -- [断开连接网站消息](passive-messages/disconnect.md) - 断开连接消息处理 -- [即将废弃的消息](passive-messages/deprecated-messages.md) - 即将废弃的消息说明 - -## 快速开始 - -1. 阅读 [主动请求概述](active-requests.md) 了解基本概念 -2. 按照 [连接网站](active-requests/connect-website.md) 进行集成 -3. 实现 [被动消息处理](passive-messages.md) 功能 -4. 测试各种功能，确保正常工作 - -## 开发注意事项 - -- 确保正确处理所有消息类型 -- 注意即将废弃的消息，及时更新代码 -- 遵循安全最佳实践 -- 测试不同网络环境下的兼容性 - -## 技术支持 - -如有问题，请参考相关文档或联系技术支持团队。 \ No newline at end of file diff --git a/docs/plugin-wallet/passive-messages/account-change.zh.md b/docs/plugin-wallet/passive-messages/account-change.zh.md index 5b05bc2..018f5c3 100644 --- a/docs/plugin-wallet/passive-messages/account-change.zh.md +++ b/docs/plugin-wallet/passive-messages/account-change.zh.md @@ -1,4 +1,3 @@ - # 账户改变消息 消息标识： `accountsChanged` diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md b/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md index 16bb996..7fcd3cd 100644 --- a/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md +++ b/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md @@ -1,6 +1,6 @@ # 用户主动连接网站消息 -#### DEPRECATED +DEPRECATED 消息标识： `connectWeb` diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 8bf38ba..1426cdb 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -82,6 +82,50 @@ a.card-link:hover { max-width: 300px; } +/* Tooltip 样式 */ +.tooltip { + position: relative; + border-bottom: 1px dotted #666; + cursor: pointer; +} + +/* Tooltip 内容 */ +.tooltip::after { + content: attr(data-tooltip); + position: absolute; + bottom: 100%; + left: 50%; + transform: translateX(-50%); + background: #333; + color: #fff; + padding: 5px 10px; + border-radius: 4px; + font-size: 14px; + white-space: nowrap; + opacity: 0; + visibility: hidden; + transition: opacity 0.3s; + width: 300px; + max-width: 500px; + white-space: wrap; + word-break: break-all; +} + +/* 悬停时显示 */ +.tooltip:hover::after { + opacity: 1; + visibility: visible; +} + +.nav-links{ + display: flex; +} + +/* add flex alignment */ +.md-footer__link { + align-items: center; +} + /* Override the responsive design part of the footer. */ @media screen and (max-width: 44.984375em) { .md-footer__link--prev .md-footer__title { diff --git a/mkdocs.yml b/mkdocs.yml index 233638e..e9715fd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,11 +44,12 @@ extra_javascript: # 插件配置 plugins: - search + - tooltips - minify: minify_html: true - i18n: default_language: en - docs_structure: suffix + docs_structure: suffix languages: - locale: en name: English @@ -65,7 +66,7 @@ plugins: - Overview: mobile/asset-management.en.md - Custom Token: mobile/asset-management/custom-tokens.en.md - DeepLink: - - Overview: mobile/deeplink.en.md + - overview: mobile/deeplink.en.md - Open Wallet: mobile/deeplink/open-wallet.en.md - Open DApp: mobile/deeplink/open-dapp.md - Login by TronLink: mobile/deeplink/login-auth.en.md @@ -156,9 +157,8 @@ plugins: use_directory_urls: true # 推荐保持为 true suffix_mode: true - # 版权信息 -copyright: Copyright © 2024 TronLink Team +copyright: Copyright © 2025 TronLink Team # 验证 validation: From 4b7e3499571de06ba943f6d916d0b7a054cc48f7 Mon Sep 17 00:00:00 2001 From: Tron Date: Mon, 21 Jul 2025 14:04:36 +0800 Subject: [PATCH 2/7] remove tooltips --- mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index e9715fd..bf1e1c4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,7 +44,6 @@ extra_javascript: # 插件配置 plugins: - search - - tooltips - minify: minify_html: true - i18n: From f32c61408e6353fe6207b89f317525a41a6a62c6 Mon Sep 17 00:00:00 2001 From: Tron Date: Mon, 21 Jul 2025 17:22:04 +0800 Subject: [PATCH 3/7] nav change --- docs/dapp/getting-started.zh.md | 4 +- docs/mobile/asset-management.en.md | 16 +- docs/mobile/asset-management.zh.md | 13 + docs/mobile/dapp-support.en.md | 32 ++- docs/mobile/dapp-support.zh.md | 24 ++ docs/mobile/deeplink.en.md | 220 +++++++++++++++ docs/mobile/deeplink.zh.md | 223 +++++++++++++++ docs/plugin-wallet/active-requests.en.md | 197 +++++++++++++ docs/plugin-wallet/active-requests.zh.md | 219 ++++++++++++++- docs/plugin-wallet/passive-messages.en.md | 322 +++++++++++++++++++++- docs/plugin-wallet/passive-messages.zh.md | 288 ++++++++++++++++++- docs/stylesheets/extra.css | 29 ++ mkdocs.yml | 126 ++++----- 13 files changed, 1630 insertions(+), 83 deletions(-) diff --git a/docs/dapp/getting-started.zh.md b/docs/dapp/getting-started.zh.md index c6f3e32..df2d6c9 100644 --- a/docs/dapp/getting-started.zh.md +++ b/docs/dapp/getting-started.zh.md @@ -25,6 +25,6 @@ 获取 tronWeb 实例后，即可进行 转账签名，多签签名，消息签名等链上交互动作。 -具体 tronWeb 实例的使用，可参考以下文档：[](https://tronweb.network/docu/docs/intro/) +具体 tronWeb 实例的使用，可参考以下文档：https://tronweb.network/docu/docs/intro -参考：[](https://developers.tron.network/docs/introduction) \ No newline at end of file +参考：https://developers.tron.network/docs/introduction \ No newline at end of file diff --git a/docs/mobile/asset-management.en.md b/docs/mobile/asset-management.en.md index 6ea970b..50ed900 100644 --- a/docs/mobile/asset-management.en.md +++ b/docs/mobile/asset-management.en.md @@ -1,9 +1,15 @@ # Asset Management -
+## Custom Token - - Custom Token → - +### What is Custom Token? -
\ No newline at end of file +Users can manually add TRC-20 and TRC-721 assets that are not recorded as tokens on TronScan as custom tokens in TronLink, which helps users search and manage their token assets more easily. + +### Add Custom Token + +Add: Add tokens in TronLink App: Home --> My Assets --> Add Custom Token + +Possible limitations: Certain TronLink features, such as "transfer" and "approve," may be unavailable when custom tokens are added in TronLink. This is because certain ABI in the contract code (e.g., transfer, approve, etc.) are not identified. TronLink will notify users when such cases occur. + +Synchronization with TronScan: If the custom token has already been recorded on TronScan, Tronlink will notify the user to synchronize token information with TronScan; once done, the custom token will adopt the corresponding token information on TronScan. diff --git a/docs/mobile/asset-management.zh.md b/docs/mobile/asset-management.zh.md index 0de0712..2ddc7d2 100644 --- a/docs/mobile/asset-management.zh.md +++ b/docs/mobile/asset-management.zh.md @@ -3,3 +3,16 @@ 管理您的资产，并支持自定义通证 +## 自定义通证 + +## **什么是自定义通证** + +自定义通证功能可以让用户将部分未在 TronScan 录入为通证的 TRC20、TRC721 资产，在 TronLink 钱包中手动添加为自定义通证，从而帮助用户查找和管理该通证资产。 + +## **添加自定义通证** + +添加：首页-->我的全部资产-->添加自定义通证 + +可能的限制：在 TronLink 钱包中添加为自定义通证后，部分合约可能会因为合约代码中缺少关键的 abi，如：transfer、approve 等，而导致相应的转账，授权等操作无法进行。TronLink 钱包会给出对应的提示。 + +与 Tronscan 同步：如果此自定义通证在 Tronscan 录入后，TronLink 钱包会提示与 Tronscan 同步，选择同步后，此自定义通证信息同步为 Tronscan 对应通证信息。 \ No newline at end of file diff --git a/docs/mobile/dapp-support.en.md b/docs/mobile/dapp-support.en.md index dae2cc1..f6df7d5 100644 --- a/docs/mobile/dapp-support.en.md +++ b/docs/mobile/dapp-support.en.md @@ -1,12 +1,28 @@ # DApp Support -
+## TronLink Integration - - TronLink Integration → - - - DApp Explorer → - +TronLink injects a version of TronWeb into the DApp that runs in TronLink's DApp Explorer. This enables the DApp to interact with TronLink DApps and the TRON network. + +Details: [Go to DApp](../../dapp/getting-started.en.md) + + +## DApp Explorer + +### Basic Function + +The DApp Explorer allows Tron DApps to run and automatically injects tronWeb and TronLink objects. + +### Extension + +Tron DApp running in the DApp Explorer injects iTron objects automatically to offer customized App service. + +##### Change screen orientation + + +```shell + // url: DApp page url + // screenModel: "1" -> vertical;"2" -> horizontal + void setScreenModel(String url, String screenModel) +``` -
\ No newline at end of file diff --git a/docs/mobile/dapp-support.zh.md b/docs/mobile/dapp-support.zh.md index 79bcf33..4e13305 100644 --- a/docs/mobile/dapp-support.zh.md +++ b/docs/mobile/dapp-support.zh.md @@ -3,3 +3,27 @@ 提供流畅的 DApp 浏览器，支持运行 TRON DApp。 +## 集成TronLink + +TronLink App 内置 DApp 浏览器，对于在其上运行的 TRON DApp，TronLink 会自动将 tronWeb 及 tronLink 对象注入到该 DApp。从而允许 DApp 与 TronLink App，以及TRON 网络交互。 + +详情：参考[DApp章节](../../dapp/getting-started.zh.md) + +## Dapp 浏览器 + +### 基本功能 + +DApp 浏览器支持运行 TRON DApp，并自动注入 tronWeb 及 tronLink 对象 + +### 扩展 + +在 DApp 浏览器中运行的 Tron DApp，会自动注入 iTron 对象，并提供 App 端定制化功能 + + * 切换屏幕方向 + +```shell + // url: DApp page url + // screenModel: "1" -> 竖屏；"2" -> 横屏 + public void setScreenModel(String url, String screenModel) +``` + diff --git a/docs/mobile/deeplink.en.md b/docs/mobile/deeplink.en.md index 6724bb2..acbe9ee 100644 --- a/docs/mobile/deeplink.en.md +++ b/docs/mobile/deeplink.en.md @@ -14,3 +14,223 @@ Process Flowchart Please be aware that only DApps that have been added to the whitelist will be able to establish a successful connection with TronLink. Kindly fill out the whitelist request form here: [Start](https://docs.google.com/forms/d/e/1FAIpQLSdFmYGxVZzwCSsvmdOTq064sxWD22STYth1g5GO5zn3OrB5Jw/viewform?usp=sf_link) + +## Open Wallet + +### Launch TronLink wallet via DeepLink + +```shell + // Tronlink-v4.10.0 + // Link + Open Tronlink +``` +```shell + // The parameter of param is the protocol data in json format + // Note: json.toString needs to be encoded with urlencode + { + "action": "open", + "protocol": "tronlink", + "version": "1.0" + } +``` + +## Open DApp + +### Use DeepLink to launch TronLink and open DApp in the DApp Explorer + +```shell + // Tronlink-v4.10.0 + // Link + Open DApp +``` +```shell + + // The parameter of param is the protocol data in json format + // Note: json.toString needs to be encoded with urlencode + { + "url": "https://www.tronlink.org/", //target DApp + "action": "open", + "protocol": "tronlink", + "version": "1.0" + } +``` + +## Login by TronLink + +```shell + // Tronlink-v4.11.0 + // Link + Login/Request Address +``` +```shell + + // The parameter of param is the protocol data in json format + // Note: json.toString needs to be encoded with urlencode + { + "url": "https://justlend.org/#/home", + "callbackUrl": "http://xxx/api/tron/v1/callback", + "dappIcon": "https://test/icon.png", + "dappName": "Test demo", + "protocol": "TronLink", + "version": "1.0", + "chainId": "0x2b6653dc", + "action": "login", + "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288" + } +``` +```shell + { + "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288", + "address": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "code": 0, + "id": 1780812177, + "message": "success" + } +``` + +## Transfer + +```shell + // Tronlink-v4.11.0 + // Link + Transfer +``` + + +```shell + { + "url": "https://justlend.org/#/home", + "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", + "dappIcon": "https://test/icon.png", + "dappName": "Test demo", + "protocol": "TronLink", + "version": "1.0", + "chainId": "0x2b6653dc", + "memo": "Reward", + "from": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "to": "TXd9duqtcyyj4pBCKvXKNqmazxxDw5SdBa", + "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "tokenId": "0", + "contract": "", + "amount": "20", + "action": "transfer", + "actionId": "408170fc-7919-4459-be5e-05a9d4b4065e" + } +``` + +```shell + { + "actionId": "099482f0-ee12-4703-bb7b-2e9d8c7c61a1", + "code": 0, + "id": 1142367107, + "message": "success", + "transactionHash": "e8ffe9b92c771e66999732b810bf2493be389464191040d8666a26dc449fa5f0" + } +``` + +## Sign Transaction + +```shell + // Tronlink-v4.11.0 + // Link + Sign transaction +``` + +```shell + // request parameter + { + "url": "https://justlend.org/#/home", + "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", + "dappIcon": "https://test/icon.png", + "dappName": "Test demo", + "protocol": "TronLink", + "version": "1.0", + "chainId": "0x2b6653dc", + "action": "sign", + "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "method": "transfer(address,uint256)", + "signType": "signTransaction", + "data": "{\"visible\":false,\"txID\":\"dcfaf2c2d75d91994f9a23623e905eaa7d74bc804fa5821640111ada3441376a\",\"raw_data\":{\"contract\":[{\"parameter\":{\"value\":{\"data\":\"a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c60200000000000000000000000000000000000000000000000000000000000000014\",\"owner_address\":\"41b42b84bad413dde093e27d01bb02ed9eede52c43\",\"contract_address\":\"41eca9bc828a3005b9a3b909f2cc5c2a54794de05f\"},\"type_url\":\"type.googleapis.com/protocol.TriggerSmartContract\"},\"type\":\"TriggerSmartContract\"}],\"ref_block_bytes\":\"84e1\",\"ref_block_hash\":\"1731d6450e11a03f\",\"expiration\":1670168865000,\"fee_limit\":100000000,\"timestamp\":1670168805340},\"raw_data_hex\":\"0a0284e122081731d6450e11a03f40e8d1c9eecd305aae01081f12a9010a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412740a1541b42b84bad413dde093e27d01bb02ed9eede52c43121541eca9bc828a3005b9a3b909f2cc5c2a54794de05f2244a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c6020000000000000000000000000000000000000000000000000000000000000001470dcffc5eecd30900180c2d72f\"}", + "actionId": "64fcdb39-2cfa-47f2-85bd-d7e8409809ed" + } +``` +```shell + // callback parameter + { + "actionId": "f5d9791a-c774-4684-805a-83784c0c86ff", + "code": 0, + "id": -799302342, + "message": "success", + "successful": true, + "transactionHash": "2fc49e560f648e5ecb455955d8778267ec1f257436425f62393b632c9a7a55ad" + } +``` + +## Sign Message +```shell + // Tronlink-v4.11.0 + Sign message +``` +```shell + // request parameter + { + "url": "https://justlend.org/#/home", + "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", + "dappIcon": "https://test/icon.png", + "dappName": "Test demo", + "protocol": "TronLink", + "version": "1.0", + "chainId": "0x2b6653dc", + "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "signType": "signStr", + "message": "abc", + "action": "sign", + "actionId": "50554861-4861-41c4-adf3-abf36213f843" + } +``` +```shell + // callback parameter + { + "actionId": "50554861-4861-41c4-adf3-abf36213f843", + "code": 0, + "id": 2001871012, + "message": "success", + "signedData": "0xffcac5731d9f70a58e5126f44c34b9356ccb9bef53331e33ddab84bb829adc1b77df24362348f8d46e506b489b4af4496600799b173e708faf1b9db99da9d13c1b" + } +``` + +## Result Code + +| id | Message | | +|:-------|:-------|:-------| +| 0 | success | | +| 10001 | Incorrect JSON format | | +| 10002 | Missing Action | | +| 10003 | Unknown Action | | +| 10004 | Missing ActionId | | +| 10005 | Incorrect DApp URL format | | +| 10006 | Incorrect CallbackUrl format | | +| 10007 | Empty DApp name | | +| 10008 | Version number not supported | | +| 10009 | Current network not supported | | +| 10010 | The URL is not supported to open TronLink | | +| 10011 | Unknown SignType | | +| 10012 | Incorrect Transaction format | | +| 10013 | Incorrect Method format | | +| 10014 | Incorrect Message format | | +| 10015 | Incorrect toAddress | | +| 10016 | No wallet created in TronLink | | +| 10017 | Incorrect fromAddress | | +| 10018 | Incorrect contactAddress | | +| 10019 | Incorrect chainId | | +| 10020 | Incorrect amount | | +| 10021 | The initiating address does not match the current wallet | | +| 10022 | incorrect loginAddress | | +| 10023 | System contract not support | | +| 10024 | Incorrect tokenId | | +| 10025 | TokenId & Contract address should not be exist together | | +| 300 | Transaction canceled | | +| 301 | Transaction executed in TronLink | | +| 302 | Broadcast failure - returned with incorrect info | | +| -1 | Unknown reason | | + diff --git a/docs/mobile/deeplink.zh.md b/docs/mobile/deeplink.zh.md index 93ad5cb..426d331 100644 --- a/docs/mobile/deeplink.zh.md +++ b/docs/mobile/deeplink.zh.md @@ -14,3 +14,226 @@ img { 注意：只有已添加至白名单的 DApp 才能成功连接至 TronLink。请在此处填写白名单申请：[填写表单](https://docs.google.com/forms/d/e/1FAIpQLSdFmYGxVZzwCSsvmdOTq064sxWD22STYth1g5GO5zn3OrB5Jw/viewform?usp=sf_link) +## 打开钱包 + +使用 DeepLink 方式唤起钱包 +```shell + // Tronlink-v4.10.0 + // 链接 + Open Tronlink +``` +```shell + // param的参数为json格式的协议数据 + // 注意：json.toString后需要进行urlencode编码 + { + "action": "open", + "protocol": "tronlink", + "version": "1.0" + } +``` + + +## 打开DApp +使用 DeepLink 方式唤起钱包，并在 DApp 浏览器中打开 DApp +```shell + // Tronlink-v4.10.0 + // 链接 + Open DApp +``` +```shell + // param的参数为json格式的协议数据 + // 注意：json.toString后需要进行urlencode编码 + { + "url": "https://www.tronlink.org/", //目标DApp + "action": "open", + "protocol": "tronlink", + "version": "1.0" + } +``` +## 登陆授权 + +使用Deeplink方式唤起钱包，并在钱包中选择获取钱包地址 + +```shell + // Tronlink-v4.11.0 + // 链接 + Login/Request Address +``` + +```shell + // param的参数为json格式的协议数据 + // 注意：json.toString后需要进行urlencode编码 + { + "url": "https://justlend.org/#/home", + "callbackUrl": "http://xxx/api/tron/v1/callback", + "dappIcon": "https://test/icon.png", + "dappName": "Test demo", + "protocol": "TronLink", + "version": "1.0", + "chainId": "0x2b6653dc", + "action": "login", + "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288" + } +``` +```shell + { + "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288", + "address": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "code": 0, + "id": 1780812177, + "message": "success" + } +``` + + +## 转账 +使用DeepLink方式唤起TronLink，并发送转账数据，在钱包中转账并广播 + +```shell + + // Tronlink-v4.11.0 + // 链接 + Transfer +``` +```shell + { + "url": "https://justlend.org/#/home", + "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", + "dappIcon": "https://test/icon.png", + "dappName": "Test demo", + "protocol": "TronLink", + "version": "1.0", + "chainId": "0x2b6653dc", + "memo": "Reward", + "from": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "to": "TXd9duqtcyyj4pBCKvXKNqmazxxDw5SdBa", + "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "tokenId": "0", + "contract": "", + "amount": "20", + "action": "transfer", + "actionId": "408170fc-7919-4459-be5e-05a9d4b4065e" + } +``` +```shell + { + "actionId": "099482f0-ee12-4703-bb7b-2e9d8c7c61a1", + "code": 0, + "id": 1142367107, + "message": "success", + "transactionHash": "e8ffe9b92c771e66999732b810bf2493be389464191040d8666a26dc449fa5f0" + } +``` + + +## 交易签名 + +```shell + // Tronlink-v4.11.0 + // 链接 + Sign transaction +``` +```shell + // request parameter + { + "url": "https://justlend.org/#/home", + "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", + "dappIcon": "https://test/icon.png", + "dappName": "Test demo", + "protocol": "TronLink", + "version": "1.0", + "chainId": "0x2b6653dc", + "action": "sign", + "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "method": "transfer(address,uint256)", + "signType": "signTransaction", + "data": "{\"visible\":false,\"txID\":\"dcfaf2c2d75d91994f9a23623e905eaa7d74bc804fa5821640111ada3441376a\",\"raw_data\":{\"contract\":[{\"parameter\":{\"value\":{\"data\":\"a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c60200000000000000000000000000000000000000000000000000000000000000014\",\"owner_address\":\"41b42b84bad413dde093e27d01bb02ed9eede52c43\",\"contract_address\":\"41eca9bc828a3005b9a3b909f2cc5c2a54794de05f\"},\"type_url\":\"type.googleapis.com/protocol.TriggerSmartContract\"},\"type\":\"TriggerSmartContract\"}],\"ref_block_bytes\":\"84e1\",\"ref_block_hash\":\"1731d6450e11a03f\",\"expiration\":1670168865000,\"fee_limit\":100000000,\"timestamp\":1670168805340},\"raw_data_hex\":\"0a0284e122081731d6450e11a03f40e8d1c9eecd305aae01081f12a9010a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412740a1541b42b84bad413dde093e27d01bb02ed9eede52c43121541eca9bc828a3005b9a3b909f2cc5c2a54794de05f2244a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c6020000000000000000000000000000000000000000000000000000000000000001470dcffc5eecd30900180c2d72f\"}", + "actionId": "64fcdb39-2cfa-47f2-85bd-d7e8409809ed" + } +``` +```shell + // callback parameter + { + "actionId": "f5d9791a-c774-4684-805a-83784c0c86ff", + "code": 0, + "id": -799302342, + "message": "success", + "successful": true, + "transactionHash": "2fc49e560f648e5ecb455955d8778267ec1f257436425f62393b632c9a7a55ad" + } +``` + +## 消息签名 + +```shell + // Tronlink-v4.11.0 + // 链接 + Sign message +``` +```shell + // request parameter + { + "url": "https://justlend.org/#/home", + "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", + "dappIcon": "https://test/icon.png", + "dappName": "Test demo", + "protocol": "TronLink", + "version": "1.0", + "chainId": "0x2b6653dc", + "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", + "signType": "signStr", + "message": "abc", + "action": "sign", + "actionId": "50554861-4861-41c4-adf3-abf36213f843" + } +``` +```shell + // callback parameter + { + "actionId": "50554861-4861-41c4-adf3-abf36213f843", + "code": 0, + "id": 2001871012, + "message": "success", + "signedData": "0xffcac5731d9f70a58e5126f44c34b9356ccb9bef53331e33ddab84bb829adc1b77df24362348f8d46e506b489b4af4496600799b173e708faf1b9db99da9d13c1b" + } +``` + + +## 回传消息码 + +| id | 消息 | 备注 | +|:-------|:-------|:-------| +| 0 | success | | +| 10001 | Incorrect JSON format | | +| 10002 | Missing Action | | +| 10003 | Unknown Action | | +| 10004 | Missing ActionId | | +| 10005 | Incorrect DApp URL format | | +| 10006 | Incorrect CallbackUrl format | | +| 10007 | Empty DApp name | v1.0 可以为空 | +| 10008 | Version number not supported | | +| 10009 | Current network not supported | | +| 10010 | The URL is not supported to open TronLink | | +| 10011 | Unknown SignType | | +| 10012 | Incorrect Transaction format | | +| 10013 | Incorrect Method format | | +| 10014 | Incorrect Message format | | +| 10015 | Incorrect toAddress | | +| 10016 | No wallet created in TronLink | | +| 10017 | Incorrect fromAddress | | +| 10018 | Incorrect contactAddress | | +| 10019 | Incorrect chainId | | +| 10020 | Incorrect amount | | +| 10021 | The initiating address does not match the current wallet | | +| 10022 | incorrect loginAddress | | +| 10023 | System contract not support | | +| 10024 | Incorrect tokenId | | +| 10025 | TokenId & Contract address should not be exist together | | +| 300 | Transaction canceled | | +| 301 | Transaction executed in TronLink | | +| 302 | Broadcast failure - returned with incorrect info | | +| -1 | Unknown reason | | + + + + diff --git a/docs/plugin-wallet/active-requests.en.md b/docs/plugin-wallet/active-requests.en.md index fa06dbc..fd8c71c 100644 --- a/docs/plugin-wallet/active-requests.en.md +++ b/docs/plugin-wallet/active-requests.en.md @@ -1,3 +1,200 @@ # Request TronLink Extension +## Connect Website + +DEPRECATED + +The methods in this section are deprecated and are expected to be removed in a few releases. The TRON community is discussing new specifications, you can go to [TRON-TIP](https://github.com/tronprotocol/tips/issues/463) to participate in the discussion. + +**Connect Website** + +**Overview** + +TronLink supports TRX transfers, contract signature, authorization, etc. initiated by DApps. For security considerations, users are required to authorize the DApp to “connect website”. They can take further actions only after successful authorization. The DApp must first connect to the website, and wait for the user's permission before it can initiate a request for authorization. + +**Specification** + +**Example** + +```shell + const res = await tronWeb.request( + { + method: 'tron_requestAccounts', + params: { + websiteIcon: '', + websiteName: '', + }, + } + ) +``` +**Parameters** + +```shell + interface RequestAccountsParams { + websiteIcon?: string; + websiteName?: string; + } +``` + +**Returns** + +```shell + interface ReqestAccountsResponse { + code: 200 | 4000 | 4001, + message: string + } +``` +| Error Code | Description | Message | +|:-------|:-------|:-------| +| null | Wallet is locked | Empty string | +| 200 | The site has previously been allowed to connect | The site is already in the whitelist | +| 200 | The user approved the connection | User allowed the request. | +| 4000 | The same DApp has already initiated a request to connect to the website, and the pop-up window has not been closed | Authorization requests are being processed, please do not resubmit | +| 4001 | The user rejected connection | User rejected the request | + +**Interaction** + +After triggering ‘tron_requestAccounts‘, there will be a pop-up window asking for confirmation: + +![image](../../images/tronlink-wallet-extension_request-tronlink-extension_connect-website_img_0.jpg) + + +## Add Token + +**Overview** + +Buttons on DApps allow users to directly add the specified tokens to the asset list on their TronLink user extension. + +**Specification** + +**Example** + +```shell + const res = await tronWeb.request({ + method: 'wallet_watchAsset', + params: { + type: 'TRC20', + options: { + address: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t' + } + }, + }); +``` +**Parameters** + +```shell + + interface WatchAssetParams { + type: 'trc10' | 'trc20' | 'trc721'; + options: { + address: string; + symbol?: string; + decimals?: number; + image?: string; + } + } +``` + * method: wallet_watchAsset fixed string + + * params: WatchAssetParams, the specific parameters are as follows: + + * type: Only 'trc10', 'trc20', 'trc721' are supported now + + * options: + + * address: the contract address of the token or the token id, required + + * symbol: placeholder (currently unused), optional + + * decimals: placeholder (currently unused), optional + + * image: placeholder (currently unused), optional + + +**Returns** + +This method has no return value + +**Interaction** + +**Add TRC10 assets** + +```shell + + if (window.tronLink.ready) { + const tronweb = tronLink.tronWeb; + try { + tronweb.request({ + method: 'wallet_watchAsset', + params: { + type: 'trc10', + options: { + address: '1002000' + }, + }, + }); + } catch (e) {} + } +``` + +When the code is executed, a TronLink pop-up window for adding TRC10 assets will show up, and the user can click “Add” or “Cancel”. + +![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_0.jpg) + +After clicking "Add", users can see the added assets as shown in the following screen: + +![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_1.jpg) + +**Add TRC20 assets** + +```shell + + if (window.tronLink.ready) { + const tronweb = tronLink.tronWeb; + try { + tronweb.request({ + method: 'wallet_watchAsset', + params: { + type: 'trc20', + options: { + address: 'TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3' + }, + }, + }); + } catch (e) {} + } +``` +When the code is executed, a TronLink pop-up window for adding TRC20 assets will show up, and the user can click “Add” or “Cancel”. + +![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_2.jpg) + +After clicking “Add”, users can see the added assets as shown in the following screen: + +![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_3.jpg) + +**Add TRC721 asset** + +```shell + if (window.tronLink.ready) { + const tronweb = tronLink.tronWeb; + try { + tronweb.request({ + method: 'wallet_watchAsset', + params: { + type: 'trc721', + options: { + address: 'TVtaUnsgKXhTfqSFRnHCsSXzPiXmm53nZt' + }, + }, + }); + } catch (e) {} + } +``` +When the code is executed, a TronLink pop-up window for adding TRC721 will show up, and the user can click “Add” or “Cancel”. + +![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_4.jpg) + +After clicking “Add”, users can see the added assets as shown in the following screen: + +![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_5.jpg) diff --git a/docs/plugin-wallet/active-requests.zh.md b/docs/plugin-wallet/active-requests.zh.md index bfd7a58..341383c 100644 --- a/docs/plugin-wallet/active-requests.zh.md +++ b/docs/plugin-wallet/active-requests.zh.md @@ -1 +1,218 @@ -# 主动请求TronLink插件功能 \ No newline at end of file +# 主动请求TronLink插件功能 + +## 连接网站 + +DEPRECATED + +本小节的方法已废弃，预计将在几个版本后移除。TRON 社区正在讨论新的规范，可以到 [TRON-TIP](https://github.com/tronprotocol/tips/issues/463) 参与讨论。 + + +**简介** + +TronLink 提供外部发起 TRX 转账，合约签名，授权等功能，基于安全的考虑， 需要用户在关键操作前先对发起请求的 DApp 进行【连接网站】授权，在授权成功后才允许操作。 所以 DApp 要先进行【连接网站】操作，等待用户允许后，方能发起需要授权的请求。 + +**技术规范** + +**代码示例** + +```shell + + const res = await tronWeb.request( + { + method: 'tron_requestAccounts', + params: { + websiteIcon: '', + websiteName: '', + }, + } + ); +``` +**参数** + +```shell + + interface RequestAccountsParams { + websiteIcon?: string; + websiteName?: string; + } +``` + * method: tron_requestAccounts 固定的字符串 + + * params: RequestAccountParams类型，具体参数如下： + + * websiteIcon: DApp 网站的图标的网址, 具体会展示在用户已连接网站列表中 + + * websiteName: DApp 网站名称 + +**返回值** + +类型说明 + +```shell + + interface ReqestAccountsResponse { + code: 200 | 4000 | 4001, + message: string + } +``` + +| 返回码 | 描述 | 返回消息 | +|:-------|:-------|:-------| +| 无 | 钱包处于锁定状态 | 空字符串 | +| 200 | 网站此前已被用户允许连接 | The site is already in the whitelist | +| 200 | 用户同意连接 | User allowed the request. | +| 4000 | 当前请求前已经有同一个 DApp 发起了连接网站请求，并且弹窗仍未关闭 | Authorization requests are being processed, please do not resubmit | +| 4001 | 用户拒绝连接 | User rejected the request | + + +**交互流程** + +触发`tron_requestAccounts`之后，会打开连接确认的弹窗： + +![image](../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_lian-jie-wang-zhan_img_0.jpg) + + +## 添加Token +**简介** + +DApp 提供按钮给用户， 直接将指定的 Token 添加到用户插件的资产展示列表中。 + +**技术规范** + +**代码示例** + +```shell + + const res = await tronWeb.request({ + method: 'wallet_watchAsset', + params: { + type: 'TRC20', + options: { + address: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t' + } + }, + }); +``` +**参数** + +```shell + + interface WatchAssetParams { + type: 'trc10' | 'trc20' | 'trc721'; + options: { + address: string; + symbol?: string; + decimals?: number; + image?: string; + } + } +``` + * method: wallet_watchAsset 固定的字符串 + + * params: WatchAssetParams，具体参数如下： + + * type: 目前只支持 'trc10', 'trc20', 'trc721' 三种 + + * options: + + * address: token 的合约地址 或者 token id, 必传 + + * symbol: 占位(目前未使用)，可选 + + * decimals: 占位(目前未使用)，可选 + + * image: 占位(目前未使用)，可选 + +**返回值** + +此方法没有返回值 + +**交互流程** + +**添加 TRC10 资产** + +```shell + + if (window.tronLink.ready) { + const tronweb = tronLink.tronWeb; + try { + tronweb.request({ + method: 'wallet_watchAsset', + params: { + type: 'trc10', + options: { + address: '1002000' + }, + }, + }); + } catch (e) {} + } +``` +代码执行时，TronLink 会弹出添加窗口，用户点击确定添加 TRC10 资产，或者取消添加。 + +![image](../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_0.jpg) + +点击“添加”按钮，资产被添加到资产列表，如下图所示： + +![image](../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_1.jpg) + + +**添加 TRC20 资产** + +```shell + + if (window.tronLink.ready) { + const tronweb = tronLink.tronWeb; + try { + tronweb.request({ + method: 'wallet_watchAsset', + params: { + type: 'trc20', + options: { + address: 'TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3' + }, + }, + }); + } catch (e) {} + } +``` +代码执行时，TronLink 会弹出添加窗口，用户点击确定添加 TRC20 资产，或者取消添加。 + +![image](../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_2.jpg) + + +点击“添加”按钮，资产被添加到资产列表，如下图所示： + +![image](../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_3.jpg) + + +**添加 TRC721 资产** + +```shell + + if (window.tronLink.ready) { + const tronweb = tronLink.tronWeb; + try { + tronweb.request({ + method: 'wallet_watchAsset', + params: { + type: 'trc721', + options: { + address: 'TVtaUnsgKXhTfqSFRnHCsSXzPiXmm53nZt' + }, + }, + }); + } catch (e) {} + } +``` +代码执行时，TronLink 会弹出添加窗口，用户点击确定添加 TRC721 资产，或者取消添加。 + +![image](../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_4.jpg) + + +点击”添加”按钮，资产被添加到资产列表，如下图所示： + +![image](../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_5.jpg) + + + diff --git a/docs/plugin-wallet/passive-messages.en.md b/docs/plugin-wallet/passive-messages.en.md index 00e3f92..d78c9d2 100644 --- a/docs/plugin-wallet/passive-messages.en.md +++ b/docs/plugin-wallet/passive-messages.en.md @@ -1,3 +1,323 @@ # Receive messages from TronLink -The message is sent using "window.postMessage", and the content received by the Dapp is a MessageEvent.You can refer to [MDN documentation of MessageEvent](https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent). +The message is sent using "window.postMessage", and the content received by the Dapp is a MessageEvent.You can refer to MDN documentation of MessageEvent. + + +## Account Change Message + +Message ID: `accountsChanged` + +**Overview** + +This message is generated when: + + 1. Users log in + + 2. Users switch accounts + + 3. Users lock accounts + + 4. The wallet is automatically locked after timeout + + + + +**Specification** + +**Example** + +```shell + + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action === "accountsChanged") { + // handler logic + console.log('got accountsChanged event', e.data) + } + }) +``` +**Returns** + +```shell + + + interface MessageEventAccountsChangedData { + isTronLink: boolean; + message: { + action: string; + data: { + address: string | boolean; + } + } + } +``` +**Return value example** + + 1. When users log in, the content of the message body is: + + + + +```shell + + + { + "data": { + "address": "TZ5XixnRyraxJJy996Q1sip85PHWuj4793" // Last selected account address + } + } +``` + 1. When users switch accounts, the content of the message body is: + + + + +```shell + { + "data": { + "address": "TRKb2nAnCBfwxnLxgoKJro6VbyA6QmsuXq" // Newly selected account address + } + } +``` + 1. When users lock accounts and the wallet is automatically locked due to timeout, the message body content is: + + + + +```shell + { + "data": { + "address": false + } + } +``` + + +## Network Change Message + +Message ID: `setNode` + +**Overview** + +Developers can monitor this message to know network changes + +This message is generated when: + + 1. When the user changes the network + + + + +**Specification** + +**Example** + +```shell + + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "setNode") { + // handler logic + console.log('got setNode event', e.data) + } + }) +``` +**Returns** + +```shell + + + { + "node": { + // Information about the current network + }, + "connectNode": { + // Node information of DApp chain + } + } +``` + +## Successful connection message + +Message ID: `connect` + +**Overview** + +Developers can monitor this message for connection changes. + +This message is generated when: + + 1. The DApp requests a connection, and the user confirms the connection in the pop-up window + + 2. Users connect to the website + + + + +**Specification** + +**Example** + +```shell + + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "connect") { + // handler logic + console.log('got connect event', e.data) + } + }) +``` + + +## Disconnect website message + +Message ID: `disconnect` + +**Overview** + +Developers can monitor this message for connection changes. + +This message is generated when: + + 1. The DApp requests a connection, and the user rejects the connection in the pop-up window + + 2. Users disconnect from the website + + + + +**Specification** + +**Example** + +```shell + + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "disconnect") { + // handler logic + console.log('got connect event', e.data) + } + }) +``` + + +## Messages to Be Deprecated + + 1. The user rejects connection: “rejectWeb” + + 2. The user disconnects from the website: “disconnectWeb” + + 3. The user accepts connection: “acceptWeb” + + 4. The user requests to connect to the website: “connectWeb” + + +### User rejects connection + +DEPRECATED + +Message ID: `rejectWeb` + +This message is generated when: + + 1. The DApp requests a connection and the user rejects the connection in the pop-up window. + + ![image](../../images/tronlink-wallet-extension_receive-messages-from-tronlink_messages-to-be-deprecated_user-rejects-connection_img_0.jpg) + + +Developers can get the connection rejection message by listening to it: + +```shell + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "rejectWeb") { + // handler logic + console.log('got rejectWeb event', e.data) + } + }) +``` + + +### User disconnects from the website + +DEPRECATED + +Message ID: `disconnectWeb` + +This message is generated when: + + 1. User actively disconnect from the website. + + ![image](../../images/tronlink-wallet-extension_receive-messages-from-tronlink_messages-to-be-deprecated_user-disconnects-from-the-website_img_0.jpg) + + + + +Developers can get the disconnection message by listening to it: + +```shell + + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "disconnectWeb") { + // handler logic + console.log('got disconnectWeb event', e.data) + } + }) +``` + + +### User accepts connection + +DEPRECATED + +Message ID: `acceptWeb` + +This message is generated when: + + 1. The user accepts connection. + + ![image](../../images/tronlink-wallet-extension_receive-messages-from-tronlink_messages-to-be-deprecated_user-accepts-connection_img_0.jpg) + + + + +Developers can get the connection acceptance message by listening to it: + +```shell + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "acceptWeb") { + // handler logic + console.log('got acceptWeb event', e.data) + } + }) +``` + + +### User requests to connect to the website + +DEPRECATED + +Message ID: `connectWeb` + +This message is generated when: + + 1. The user requests to connect to the website. + + ![image](../../images/tronlink-wallet-extension_receive-messages-from-tronlink_messages-to-be-deprecated_user-requests-to-connect-to-the-website_img_0.jpg) + + + + +Developers can get the connection request message by listening to it: + +```shell + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "connectWeb") { + // handler logic + console.log('got connectWeb event', e.data) + } + }) +``` diff --git a/docs/plugin-wallet/passive-messages.zh.md b/docs/plugin-wallet/passive-messages.zh.md index d08cb7f..f2ccebc 100644 --- a/docs/plugin-wallet/passive-messages.zh.md +++ b/docs/plugin-wallet/passive-messages.zh.md @@ -1,5 +1,291 @@ # 被动接收TronLink插件的消息 -消息使用 window.postMessage 发送，Dapp 接收到的内容是一个 MessageEvent ，可以参考[MessageEvent的MDN文档](https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent)。 +消息使用 window.postMessage 发送，Dapp 接收到的内容是一个 MessageEvent ，可以参考[MessageEvent的MDN文档]。 + +## 账户改变消息 + +消息标识： `accountsChanged` + +**简介** + +以下情况会产生此消息 + + 1. 用户登陆 + + 2. 用户切换账号 + + 3. 用户锁定账号 + + 4. 钱包超时自动锁定 + +**技术规范** + +**代码示例** + +```shell + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action === "accountsChanged") { + // handler logic + console.log('got accountsChanged event', e.data) + } + }) +``` +**返回值** + +```shell + + interface MessageEventAccountsChangedData { + isTronLink: boolean; + message: { + action: string; + data: { + address: string | boolean; + } + } + } +``` +**返回值示例** + + 1. 用户登陆时，消息体内容为： + +```shell + + { + "data": { + "address": "TZ5XixnRyraxJJy996Q1sip85PHWuj4793" // 上次选择的账号地址 + } + } +``` + 1. 用户切换账号时，消息体内容为： + +```shell + + { + "data": { + "address": "TRKb2nAnCBfwxnLxgoKJro6VbyA6QmsuXq" // 新选择的账号地址 + } + } +``` + 1. 用户锁定和钱包超时自动锁定时，消息体内容为： + +```shell + + { + "data": { + "address": false + } + } +``` + +## 网络改变消息 + +消息标识： `setNode` + +**简介** + +开发者可以监听此消息来获取网络的改变 + +以下情况会产生此消息 + + 1. 用户改变网络的时候 + +**技术规范** + +**代码示例** + +```shell + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "setNode") { + // handler logic + console.log('got setNode event', e.data) + } + }) +``` +**返回值** + +```shell + + { + "node": { + // 当前网络的信息 + }, + "connectNode": { + // dapp chain 的节点信息 + } + } +``` + +## 连接网站成功消息 + +消息标识： `connect` + +**简介** + +开发者可以监听此消息来获取网络的改变。 + +以下情况会产生此消息： + + 1. DApp 请求连接，用户在弹窗中确定连接后 + + 2. 用户主动连接网站 + +**技术规范** + +**代码示例** + +```shell + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "connect") { + // handler logic + console.log('got connect event', e.data) + } + }) +``` + + +## 断开连接网站消息 + +消息标识： `disconnect` + +**简介** + +开发者可以监听此消息来获取网络的改变。 + +以下情况会产生此消息： + + 1. DApp 请求连接，用户在弹窗中拒绝连接后 + + 2. 用户主动断开连接网站 + +**技术规范** + +**代码示例** + +```shell + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "disconnect") { + // handler logic + console.log('got connect event', e.data) + } + }) +``` + + +## 即将废弃的消息 + +以下四个消息在未来4.x版本将会被废弃 + + 1. 用户拒绝连接消息`rejectWeb` + + 2. 用户断连网站消息`disconnectWeb` + + 3. 用户确定连接消息`acceptWeb` + + 4. 用户主动连接网站消息`connectWeb` + +#### 用户拒绝连接消息 + +DEPRECATED + +消息标识： `rejectWeb` + +以下情况会产生此消息： + + 1. DApp 请求连接，用户在弹窗中拒绝连接后 + +![image](../images/zh_cha-jian-qian-bao_bei-dong-jie-shou-tronlink-cha-jian-de-xiao-xi_ji-jiang-fei-qi-de-xiao-xi_yong-hu-ju-jue-lian-jie-xiao-xi_img_0.jpg) + +开发者可以监听此消息来获取用户拒绝连接消息 + +```shell + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "rejectWeb") { + // handler logic + console.log('got rejectWeb event', e.data) + } + }) +``` + + +### 用户断连网站消息 + +DEPRECATED + +消息标识： `disconnectWeb` + +以下情况会产生此消息 + + 1. 用户主动断接网站 + +![image](../images/zh_cha-jian-qian-bao_bei-dong-jie-shou-tronlink-cha-jian-de-xiao-xi_ji-jiang-fei-qi-de-xiao-xi_yong-hu-duan-lian-wang-zhan-xiao-xi_img_0.jpg) + +开发者可以监听此消息来获取用户主动断连消息 + +```shell + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "disconnectWeb") { + // handler logic + console.log('got disconnectWeb event', e.data) + } + }) +``` + + +### 用户确定连接消息 + +DEPRECATED + +消息标识： `acceptWeb` + +以下情况会产生此消息 + + 1. 用户确定连接消息 + + ![image](../images/zh_cha-jian-qian-bao_bei-dong-jie-shou-tronlink-cha-jian-de-xiao-xi_ji-jiang-fei-qi-de-xiao-xi_yong-hu-que-ding-lian-jie-xiao-xi_img_0.jpg) + +开发者可以监听此消息来获取用户确定连接消息 + +```shell + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "acceptWeb") { + // handler logic + console.log('got acceptWeb event', e.data) + } + }) +``` + +### 用户主动连接网站消息 + +DEPRECATED + +消息标识： `connectWeb` + +以下情况会产生此消息 + + 1. 用户确定连接消息 + +![image](../images/zh_cha-jian-qian-bao_bei-dong-jie-shou-tronlink-cha-jian-de-xiao-xi_ji-jiang-fei-qi-de-xiao-xi_yong-hu-zhu-dong-lian-jie-wang-zhan-xiao-xi_img_0.jpg) + +开发者可以监听此消息来获取用户主动连接网站消息 + +```shell + + window.addEventListener('message', function (e) { + if (e.data.message && e.data.message.action == "connectWeb") { + // handler logic + console.log('got connectWeb event', e.data) + } + }) +``` + + + + diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 1426cdb..73a338d 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -126,6 +126,35 @@ a.card-link:hover { align-items: center; } + +/* 为有子目录项的链接添加箭头图标 */ +.md-nav__item.has-children > .md-nav__link { + position: relative; + padding-right: 20px; /* 为图标留出空间 */ +} + +.md-nav__item.has-children > .md-nav__link::after { + content: "⟩"; /* 使用尖括号 */ + position: absolute; + right: 0; + top: 50%; + transform: translateY(-50%); + font-size: 1em; + font-weight: 900; + transition: transform 0.2s ease; /* 添加旋转动画 */ +} + +/* 展开时旋转 90 度 */ +.md-nav__item.has-children.is-expanded > .md-nav__link::after { + transform: translateY(-50%) rotate(90deg); +} + +/*设置一级导航字体的颜色以增加和二级导航的区分度*/ +.md-nav--primary .md-nav__item--section > .md-nav__link { + color: #000; + font-size: 1.1em; +} + /* Override the responsive design part of the footer. */ @media screen and (max-width: 44.984375em) { .md-footer__link--prev .md-footer__title { diff --git a/mkdocs.yml b/mkdocs.yml index bf1e1c4..ca91f8a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,7 +22,6 @@ theme: - content.code.copy - content.code.annotate - content.tabs.link - - content.tooltips - header.autohide - toc.integrate - search.highlight # 搜索时高亮匹配内容 @@ -61,40 +60,37 @@ plugins: - HD Wallets: hd-wallets.en.md - TronLink App: # - Overview: mobile/index.en.md - - Asset Management: - - Overview: mobile/asset-management.en.md - - Custom Token: mobile/asset-management/custom-tokens.en.md - - DeepLink: - - overview: mobile/deeplink.en.md - - Open Wallet: mobile/deeplink/open-wallet.en.md - - Open DApp: mobile/deeplink/open-dapp.md - - Login by TronLink: mobile/deeplink/login-auth.en.md - - Transfer: mobile/deeplink/transfer.md - - Sign Transaction: mobile/deeplink/transaction-signing.en.md - - Sign Message: mobile/deeplink/message-signing.en.md - - Result Code: mobile/deeplink/callback-codes.en.md - - DApp Support: - - Overview: mobile/dapp-support.en.md - - TronLink Integration: mobile/dapp-support/integrate-tronlink.md - - DApp Explorer: mobile/dapp-support/dapp-browser.md + - Asset Management: mobile/asset-management.en.md + - DeepLink: mobile/deeplink.en.md + # - Open Wallet: mobile/deeplink/open-wallet.en.md + # - Open DApp: mobile/deeplink/open-dapp.md + # - Login by TronLink: mobile/deeplink/login-auth.en.md + # - Transfer: mobile/deeplink/transfer.md + # - Sign Transaction: mobile/deeplink/transaction-signing.en.md + # - Sign Message: mobile/deeplink/message-signing.en.md + # - Result Code: mobile/deeplink/callback-codes.en.md + - DApp Support: mobile/dapp-support.en.md + # - Overview: mobile/dapp-support.en.md + # - TronLink Integration: mobile/dapp-support/integrate-tronlink.md + # - DApp Explorer: mobile/dapp-support/dapp-browser.md - TronLink Wallet Extension: # - Overview: plugin-wallet/index.md - - Request TronLink Extension: - - Overview: plugin-wallet/active-requests.en.md - - Connect Website: plugin-wallet/active-requests/connect-website.en.md - - Add Token: plugin-wallet/active-requests/add-token.en.md - - Receive messages from TronLink: - - Overview: plugin-wallet/passive-messages.en.md - - Account Change Message: plugin-wallet/passive-messages/account-change.en.md - - Network Change Message: plugin-wallet/passive-messages/network-change.en.md - - Successful connection message: plugin-wallet/passive-messages/connect-success.en.md - - Disconnect website message: plugin-wallet/passive-messages/disconnect.en.md - - Messages to Be Deprecated: - - Overview: plugin-wallet/passive-messages/deprecated-messages.en.md - - User rejects connection: plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.en.md - - User disconnects from the website: plugin-wallet/passive-messages/deprecated-messages/user-disconnect.en.md - - User accepts connection: plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.en.md - - User requests to connect to the website: plugin-wallet/passive-messages/deprecated-messages/user-active-connect.en.md + - Request TronLink Extension: plugin-wallet/active-requests.en.md + # - Overview: plugin-wallet/active-requests.en.md + # - Connect Website: plugin-wallet/active-requests/connect-website.en.md + # - Add Token: plugin-wallet/active-requests/add-token.en.md + - Receive messages from TronLink: plugin-wallet/passive-messages.en.md + # - Overview: plugin-wallet/passive-messages.en.md + # - Account Change Message: plugin-wallet/passive-messages/account-change.en.md + # - Network Change Message: plugin-wallet/passive-messages/network-change.en.md + # - Successful connection message: plugin-wallet/passive-messages/connect-success.en.md + # - Disconnect website message: plugin-wallet/passive-messages/disconnect.en.md + # - Messages to Be Deprecated: + # - Overview: plugin-wallet/passive-messages/deprecated-messages.en.md + # - User rejects connection: plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.en.md + # - User disconnects from the website: plugin-wallet/passive-messages/deprecated-messages/user-disconnect.en.md + # - User accepts connection: plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.en.md + # - User requests to connect to the website: plugin-wallet/passive-messages/deprecated-messages/user-active-connect.en.md - DApp: # - Overview: dapp/index.en.md - Start Developing: dapp/getting-started.en.md @@ -112,40 +108,40 @@ plugins: - HD 钱包: hd-wallets.zh.md - 移动端: # - 概述: mobile/index.zh.md - - 资产管理: - - 概述: mobile/asset-management.zh.md - - 自定义通证: mobile/asset-management/custom-tokens.zh.md - - DeepLink: - - 概述: mobile/deeplink.zh.md - - 打开钱包: mobile/deeplink/open-wallet.zh.md - - 打开DApp: mobile/deeplink/open-dapp.zh.md - - 登陆授权: mobile/deeplink/login-auth.zh.md - - 转账: mobile/deeplink/transfer.zh.md - - 交易签名: mobile/deeplink/transaction-signing.zh.md - - 消息签名: mobile/deeplink/message-signing.zh.md - - 回传消息码: mobile/deeplink/callback-codes.zh.md - - DApp支持: - - 概述: mobile/dapp-support.zh.md - - 集成TronLink: mobile/dapp-support/integrate-tronlink.zh.md - - DApp浏览器: mobile/dapp-support/dapp-browser.zh.md + - 资产管理: mobile/asset-management.zh.md + # - 概述: mobile/asset-management.zh.md + # - 自定义通证: mobile/asset-management/custom-tokens.zh.md + - DeepLink: mobile/deeplink.zh.md + # - 概述: mobile/deeplink.zh.md + # - 打开钱包: mobile/deeplink/open-wallet.zh.md + # - 打开DApp: mobile/deeplink/open-dapp.zh.md + # - 登陆授权: mobile/deeplink/login-auth.zh.md + # - 转账: mobile/deeplink/transfer.zh.md + # - 交易签名: mobile/deeplink/transaction-signing.zh.md + # - 消息签名: mobile/deeplink/message-signing.zh.md + # - 回传消息码: mobile/deeplink/callback-codes.zh.md + - DApp支持: mobile/dapp-support.zh.md + # - 概述: mobile/dapp-support.zh.md + # - 集成TronLink: mobile/dapp-support/integrate-tronlink.zh.md + # - DApp浏览器: mobile/dapp-support/dapp-browser.zh.md - 插件钱包: # - 概述: plugin-wallet/index.zh.md - - 主动请求TronLink插件功能: - - 概述: plugin-wallet/active-requests.zh.md - - 连接网站: plugin-wallet/active-requests/connect-website.zh.md - - 添加Token: plugin-wallet/active-requests/add-token.zh.md - - 被动接收TronLink插件的消息: - - 概述: plugin-wallet/passive-messages.zh.md - - 账户改变消息: plugin-wallet/passive-messages/account-change.zh.md - - 网络改变消息: plugin-wallet/passive-messages/network-change.zh.md - - 连接网站成功消息: plugin-wallet/passive-messages/connect-success.zh.md - - 断开连接网站消息: plugin-wallet/passive-messages/disconnect.zh.md - - 即将废弃的消息: - - 概述: plugin-wallet/passive-messages/deprecated-messages.zh.md - - 用户拒绝连接消息: plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.zh.md - - 用户断连网站消息: plugin-wallet/passive-messages/deprecated-messages/user-disconnect.zh.md - - 用户确定连接消息: plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.zh.md - - 用户主动连接网站消息: plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md + - 主动请求TronLink插件功能: plugin-wallet/active-requests.zh.md + # - 概述: plugin-wallet/active-requests.zh.md + # - 连接网站: plugin-wallet/active-requests/connect-website.zh.md + # - 添加Token: plugin-wallet/active-requests/add-token.zh.md + - 被动接收TronLink插件的消息: plugin-wallet/passive-messages.zh.md + # - 概述: plugin-wallet/passive-messages.zh.md + # - 账户改变消息: plugin-wallet/passive-messages/account-change.zh.md + # - 网络改变消息: plugin-wallet/passive-messages/network-change.zh.md + # - 连接网站成功消息: plugin-wallet/passive-messages/connect-success.zh.md + # - 断开连接网站消息: plugin-wallet/passive-messages/disconnect.zh.md + # - 即将废弃的消息: + # - 概述: plugin-wallet/passive-messages/deprecated-messages.zh.md + # - 用户拒绝连接消息: plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.zh.md + # - 用户断连网站消息: plugin-wallet/passive-messages/deprecated-messages/user-disconnect.zh.md + # - 用户确定连接消息: plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.zh.md + # - 用户主动连接网站消息: plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md - DApp: # - 概述: dapp/index.zh.md - 开始开发: dapp/getting-started.zh.md From f29023449e9564ebd594c11808b36d759d5cc5be Mon Sep 17 00:00:00 2001 From: Tron Date: Mon, 21 Jul 2025 17:28:14 +0800 Subject: [PATCH 4/7] Directory structure modification --- docs/index.en.md | 17 ----------------- docs/index.zh.md | 17 ----------------- 2 files changed, 34 deletions(-) diff --git a/docs/index.en.md b/docs/index.en.md index 5ea288c..386161a 100644 --- a/docs/index.en.md +++ b/docs/index.en.md @@ -10,29 +10,12 @@ Welcome to the TronLink Developer Documentation! TronLink is a decentralized wal ### TronLink App - [Asset Management](mobile/asset-management) - Asset management features - - [Custom Tokens](mobile/asset-management/custom-tokens) - Custom token management - [DeepLink](mobile/deeplink) - DeepLink integration - - [Open Wallet](mobile/deeplink/open-wallet) - Open wallet functionality - - [Open DApp](mobile/deeplink/open-dapp) - Open DApp functionality - - [Login by TronLink](mobile/deeplink/login-auth) - Login authorization functionality - - [Transfer](mobile/deeplink/transfer) - Transfer functionality - - [Sign Transaction](mobile/deeplink/transaction-signing) - Transaction signing functionality - - [Sign Message](mobile/deeplink/message-signing) - Message signing functionality - - [Result Code](mobile/deeplink/callback-codes) - Callback message codes - [DApp Support](mobile/dapp-support) - DApp browser support - - [TronLink Integration](mobile/dapp-support/integrate-tronlink) - Integrate TronLink - - [DApp Explorer](mobile/dapp-support/dapp-browser) - DApp browser ### TronLink Wallet Extension - [Request TronLink Extension](plugin-wallet/active-requests) - Active request TronLink plugin functions - - [Connect Website](plugin-wallet/active-requests/connect-website) - Connect website - - [Add Token](plugin-wallet/active-requests/add-token) - Add token - [Receive messages from TronLink](plugin-wallet/passive-messages) - Passively receive messages from TronLink plugin - - [Account Change Message](plugin-wallet/passive-messages/account-change) - Account change message - - [Network Change Message](plugin-wallet/passive-messages/network-change) - Network change message - - [Successful connection message](plugin-wallet/passive-messages/connect-success) - Website connection success message - - [Disconnect website message](plugin-wallet/passive-messages/disconnect) - Disconnect website message - - [Messages to Be Deprecated](plugin-wallet/passive-messages/deprecated-messages) - Deprecated messages ### DApp - [Start Developing](dapp/getting-started) - Quick start guide diff --git a/docs/index.zh.md b/docs/index.zh.md index 981c074..0fd7f7e 100644 --- a/docs/index.zh.md +++ b/docs/index.zh.md @@ -10,29 +10,12 @@ ### 移动端 - [资产管理](mobile/asset-management) - 资产管理功能 - - [自定义通证](mobile/asset-management/custom-tokens) - 自定义通证管理 - [DeepLink](mobile/deeplink) - DeepLink 集成 - - [打开钱包](mobile/deeplink/open-wallet) - 打开钱包功能 - - [打开DApp](mobile/deeplink/open-dapp) - 打开DApp功能 - - [登陆授权](mobile/deeplink/login-auth) - 登陆授权功能 - - [转账](mobile/deeplink/transfer) - 转账功能 - - [交易签名](mobile/deeplink/transaction-signing) - 交易签名功能 - - [消息签名](mobile/deeplink/message-signing) - 消息签名功能 - - [回传消息码](mobile/deeplink/callback-codes) - 回传消息码 - [DApp 支持](mobile/dapp-support) - DApp 浏览器支持 - - [集成TronLink](mobile/dapp-support/integrate-tronlink) - 集成TronLink - - [DApp浏览器](mobile/dapp-support/dapp-browser) - DApp浏览器 ### 插件钱包 - [主动请求功能](plugin-wallet/active-requests) - 主动请求TronLink插件功能 - - [连接网站](plugin-wallet/active-requests/connect-website) - 连接网站 - - [添加Token](plugin-wallet/active-requests/add-token) - 添加Token - [被动接收消息](plugin-wallet/passive-messages) - 被动接收TronLink插件的消息 - - [账户改变消息](plugin-wallet/passive-messages/account-change) - 账户改变消息 - - [网络改变消息](plugin-wallet/passive-messages/network-change) - 网络改变消息 - - [连接网站成功消息](plugin-wallet/passive-messages/connect-success) - 连接网站成功消息 - - [断开连接网站消息](plugin-wallet/passive-messages/disconnect) - 断开连接网站消息 - - [即将废弃的消息](plugin-wallet/passive-messages/deprecated-messages) - 即将废弃的消息 ### DApp - [开始开发](dapp/getting-started) - 快速开始 From 539cebda50543a1dd258c9208ccedd816661654a Mon Sep 17 00:00:00 2001 From: Tron Date: Tue, 22 Jul 2025 10:35:32 +0800 Subject: [PATCH 5/7] assets token page --- docs/mobile/asset-management.zh.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/mobile/asset-management.zh.md b/docs/mobile/asset-management.zh.md index 2ddc7d2..91d150a 100644 --- a/docs/mobile/asset-management.zh.md +++ b/docs/mobile/asset-management.zh.md @@ -5,11 +5,11 @@ ## 自定义通证 -## **什么是自定义通证** +### **什么是自定义通证** 自定义通证功能可以让用户将部分未在 TronScan 录入为通证的 TRC20、TRC721 资产，在 TronLink 钱包中手动添加为自定义通证，从而帮助用户查找和管理该通证资产。 -## **添加自定义通证** +### **添加自定义通证** 添加：首页-->我的全部资产-->添加自定义通证 From 66e2d94d4f7b3465d6c924fe198234389cfc5c68 Mon Sep 17 00:00:00 2001 From: Tron Date: Tue, 22 Jul 2025 14:43:35 +0800 Subject: [PATCH 6/7] add tooltip --- docs/dapp/getting-started.en.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dapp/getting-started.en.md b/docs/dapp/getting-started.en.md index f446f4b..4338f0b 100644 --- a/docs/dapp/getting-started.en.md +++ b/docs/dapp/getting-started.en.md @@ -21,7 +21,7 @@ This document will guide you to connect your DApp with the TronLink application } ``` -After getting the tronWeb instance, you can perform on-chain interactive actions such as signing transfers, multi-signature transactions, and messages. For use cases of the tronWeb instance, please refer to the following document: [](https://tronweb.network/docu/docs/intro/) +After getting the tronWeb instance, you can perform on-chain interactive actions such as signing transfers, multi-signature transactions, and messages. For use cases of the tronWeb instance, please refer to the following document: https://tronweb.network/docu/docs/intro -Reference: [](https://developers.tron.network/docs/introduction) +Reference: https://developers.tron.network/docs/introduction From 79cd90e67908f2fe9e0e541335f7ef56f3af22c1 Mon Sep 17 00:00:00 2001 From: Tron Date: Tue, 22 Jul 2025 22:22:27 +0800 Subject: [PATCH 7/7] remove no use page --- .../asset-management/custom-tokens.en.md | 13 -- .../asset-management/custom-tokens.zh.md | 15 -- docs/mobile/dapp-support/dapp-browser.en.md | 19 --- docs/mobile/dapp-support/dapp-browser.zh.md | 18 --- .../dapp-support/integrate-tronlink.en.md | 5 - .../dapp-support/integrate-tronlink.zh.md | 6 - docs/mobile/deeplink/callback-codes.en.md | 35 ----- docs/mobile/deeplink/callback-codes.zh.md | 35 ----- docs/mobile/deeplink/login-auth.en.md | 32 ---- docs/mobile/deeplink/login-auth.zh.md | 34 ----- docs/mobile/deeplink/message-signing.en.md | 33 ---- docs/mobile/deeplink/message-signing.zh.md | 35 ----- docs/mobile/deeplink/open-dapp.en.md | 20 --- docs/mobile/deeplink/open-dapp.zh.md | 18 --- docs/mobile/deeplink/open-wallet.en.md | 18 --- docs/mobile/deeplink/open-wallet.zh.md | 18 --- .../mobile/deeplink/transaction-signing.en.md | 37 ----- .../mobile/deeplink/transaction-signing.zh.md | 36 ----- docs/mobile/deeplink/transfer.en.md | 39 ----- docs/mobile/deeplink/transfer.zh.md | 40 ----- .../active-requests/add-token.en.md | 138 ----------------- .../active-requests/add-token.zh.md | 144 ------------------ .../active-requests/connect-website.en.md | 57 ------- .../active-requests/connect-website.zh.md | 73 --------- .../passive-messages/account-change.en.md | 88 ----------- .../passive-messages/account-change.zh.md | 76 --------- .../passive-messages/connect-success.en.md | 31 ---- .../passive-messages/connect-success.zh.md | 27 ---- .../deprecated-messages.en.md | 10 -- .../deprecated-messages.zh.md | 12 -- .../user-active-connect.en.md | 25 --- .../user-active-connect.zh.md | 24 --- .../user-confirm-connect.en.md | 25 --- .../user-confirm-connect.zh.md | 24 --- .../deprecated-messages/user-disconnect.en.md | 27 ---- .../deprecated-messages/user-disconnect.zh.md | 24 --- .../user-reject-connect.en.md | 25 --- .../user-reject-connect.zh.md | 23 --- .../passive-messages/disconnect.en.md | 31 ---- .../passive-messages/disconnect.zh.md | 28 ---- .../passive-messages/network-change.en.md | 43 ------ .../passive-messages/network-change.zh.md | 39 ----- mkdocs.yml | 58 ------- 43 files changed, 1558 deletions(-) delete mode 100644 docs/mobile/asset-management/custom-tokens.en.md delete mode 100644 docs/mobile/asset-management/custom-tokens.zh.md delete mode 100644 docs/mobile/dapp-support/dapp-browser.en.md delete mode 100644 docs/mobile/dapp-support/dapp-browser.zh.md delete mode 100644 docs/mobile/dapp-support/integrate-tronlink.en.md delete mode 100644 docs/mobile/dapp-support/integrate-tronlink.zh.md delete mode 100644 docs/mobile/deeplink/callback-codes.en.md delete mode 100644 docs/mobile/deeplink/callback-codes.zh.md delete mode 100644 docs/mobile/deeplink/login-auth.en.md delete mode 100644 docs/mobile/deeplink/login-auth.zh.md delete mode 100644 docs/mobile/deeplink/message-signing.en.md delete mode 100644 docs/mobile/deeplink/message-signing.zh.md delete mode 100644 docs/mobile/deeplink/open-dapp.en.md delete mode 100644 docs/mobile/deeplink/open-dapp.zh.md delete mode 100644 docs/mobile/deeplink/open-wallet.en.md delete mode 100644 docs/mobile/deeplink/open-wallet.zh.md delete mode 100644 docs/mobile/deeplink/transaction-signing.en.md delete mode 100644 docs/mobile/deeplink/transaction-signing.zh.md delete mode 100644 docs/mobile/deeplink/transfer.en.md delete mode 100644 docs/mobile/deeplink/transfer.zh.md delete mode 100644 docs/plugin-wallet/active-requests/add-token.en.md delete mode 100644 docs/plugin-wallet/active-requests/add-token.zh.md delete mode 100644 docs/plugin-wallet/active-requests/connect-website.en.md delete mode 100644 docs/plugin-wallet/active-requests/connect-website.zh.md delete mode 100644 docs/plugin-wallet/passive-messages/account-change.en.md delete mode 100644 docs/plugin-wallet/passive-messages/account-change.zh.md delete mode 100644 docs/plugin-wallet/passive-messages/connect-success.en.md delete mode 100644 docs/plugin-wallet/passive-messages/connect-success.zh.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages.en.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages.zh.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.en.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.en.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.zh.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages/user-disconnect.en.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages/user-disconnect.zh.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.en.md delete mode 100644 docs/plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.zh.md delete mode 100644 docs/plugin-wallet/passive-messages/disconnect.en.md delete mode 100644 docs/plugin-wallet/passive-messages/disconnect.zh.md delete mode 100644 docs/plugin-wallet/passive-messages/network-change.en.md delete mode 100644 docs/plugin-wallet/passive-messages/network-change.zh.md diff --git a/docs/mobile/asset-management/custom-tokens.en.md b/docs/mobile/asset-management/custom-tokens.en.md deleted file mode 100644 index 7556438..0000000 --- a/docs/mobile/asset-management/custom-tokens.en.md +++ /dev/null @@ -1,13 +0,0 @@ -# Custom Token - -## What is Custom Token? - -Users can manually add TRC-20 and TRC-721 assets that are not recorded as tokens on TronScan as custom tokens in TronLink, which helps users search and manage their token assets more easily. - -## Add Custom Token - -Add: Add tokens in TronLink App: Home --> My Assets --> Add Custom Token - -Possible limitations: Certain TronLink features, such as "transfer" and "approve," may be unavailable when custom tokens are added in TronLink. This is because certain ABI in the contract code (e.g., transfer, approve, etc.) are not identified. TronLink will notify users when such cases occur. - -Synchronization with TronScan: If the custom token has already been recorded on TronScan, Tronlink will notify the user to synchronize token information with TronScan; once done, the custom token will adopt the corresponding token information on TronScan. diff --git a/docs/mobile/asset-management/custom-tokens.zh.md b/docs/mobile/asset-management/custom-tokens.zh.md deleted file mode 100644 index 8d6dd20..0000000 --- a/docs/mobile/asset-management/custom-tokens.zh.md +++ /dev/null @@ -1,15 +0,0 @@ -# 自定义通证 - -## **什么是自定义通证** - -自定义通证功能可以让用户将部分未在 TronScan 录入为通证的 TRC20、TRC721 资产，在 TronLink 钱包中手动添加为自定义通证，从而帮助用户查找和管理该通证资产。 - -## **添加自定义通证** - -添加：首页-->我的全部资产-->添加自定义通证 - -可能的限制：在 TronLink 钱包中添加为自定义通证后，部分合约可能会因为合约代码中缺少关键的 abi，如：transfer、approve 等，而导致相应的转账，授权等操作无法进行。TronLink 钱包会给出对应的提示。 - -与 Tronscan 同步：如果此自定义通证在 Tronscan 录入后，TronLink 钱包会提示与 Tronscan 同步，选择同步后，此自定义通证信息同步为 Tronscan 对应通证信息。 - - diff --git a/docs/mobile/dapp-support/dapp-browser.en.md b/docs/mobile/dapp-support/dapp-browser.en.md deleted file mode 100644 index 9d9cc8e..0000000 --- a/docs/mobile/dapp-support/dapp-browser.en.md +++ /dev/null @@ -1,19 +0,0 @@ -# DApp Explorer - -## Basic Function - -The DApp Explorer allows Tron DApps to run and automatically injects tronWeb and TronLink objects. - -## Extension - -Tron DApp running in the DApp Explorer injects iTron objects automatically to offer customized App service. - -#### Change screen orientation - - -```shell - // url: DApp page url - // screenModel: "1" -> vertical;"2" -> horizontal - void setScreenModel(String url, String screenModel) -``` - diff --git a/docs/mobile/dapp-support/dapp-browser.zh.md b/docs/mobile/dapp-support/dapp-browser.zh.md deleted file mode 100644 index f55db8e..0000000 --- a/docs/mobile/dapp-support/dapp-browser.zh.md +++ /dev/null @@ -1,18 +0,0 @@ -# Dapp 浏览器 - -### 基本功能 - -DApp 浏览器支持运行 TRON DApp，并自动注入 tronWeb 及 tronLink 对象 - -### 扩展 - -在 DApp 浏览器中运行的 Tron DApp，会自动注入 iTron 对象，并提供 App 端定制化功能 - - * 切换屏幕方向 - -```shell - // url: DApp page url - // screenModel: "1" -> 竖屏；"2" -> 横屏 - public void setScreenModel(String url, String screenModel) -``` - diff --git a/docs/mobile/dapp-support/integrate-tronlink.en.md b/docs/mobile/dapp-support/integrate-tronlink.en.md deleted file mode 100644 index 88cbfb7..0000000 --- a/docs/mobile/dapp-support/integrate-tronlink.en.md +++ /dev/null @@ -1,5 +0,0 @@ -# TronLink Integration - -TronLink injects a version of TronWeb into the DApp that runs in TronLink's DApp Explorer. This enables the DApp to interact with TronLink DApps and the TRON network. - -Details: [Go to DApp](../../dapp/getting-started.en.md) diff --git a/docs/mobile/dapp-support/integrate-tronlink.zh.md b/docs/mobile/dapp-support/integrate-tronlink.zh.md deleted file mode 100644 index 3f3814a..0000000 --- a/docs/mobile/dapp-support/integrate-tronlink.zh.md +++ /dev/null @@ -1,6 +0,0 @@ -# 集成TronLink - -TronLink App 内置 DApp 浏览器，对于在其上运行的 TRON DApp，TronLink 会自动将 tronWeb 及 tronLink 对象注入到该 DApp。从而允许 DApp 与 TronLink App，以及TRON 网络交互。 - -详情：参考[DApp章节](../../dapp/getting-started.zh.md) - diff --git a/docs/mobile/deeplink/callback-codes.en.md b/docs/mobile/deeplink/callback-codes.en.md deleted file mode 100644 index 7e217ba..0000000 --- a/docs/mobile/deeplink/callback-codes.en.md +++ /dev/null @@ -1,35 +0,0 @@ -# Result Code - -| id | Message | | -|:-------|:-------|:-------| -| 0 | success | | -| 10001 | Incorrect JSON format | | -| 10002 | Missing Action | | -| 10003 | Unknown Action | | -| 10004 | Missing ActionId | | -| 10005 | Incorrect DApp URL format | | -| 10006 | Incorrect CallbackUrl format | | -| 10007 | Empty DApp name | | -| 10008 | Version number not supported | | -| 10009 | Current network not supported | | -| 10010 | The URL is not supported to open TronLink | | -| 10011 | Unknown SignType | | -| 10012 | Incorrect Transaction format | | -| 10013 | Incorrect Method format | | -| 10014 | Incorrect Message format | | -| 10015 | Incorrect toAddress | | -| 10016 | No wallet created in TronLink | | -| 10017 | Incorrect fromAddress | | -| 10018 | Incorrect contactAddress | | -| 10019 | Incorrect chainId | | -| 10020 | Incorrect amount | | -| 10021 | The initiating address does not match the current wallet | | -| 10022 | incorrect loginAddress | | -| 10023 | System contract not support | | -| 10024 | Incorrect tokenId | | -| 10025 | TokenId & Contract address should not be exist together | | -| 300 | Transaction canceled | | -| 301 | Transaction executed in TronLink | | -| 302 | Broadcast failure - returned with incorrect info | | -| -1 | Unknown reason | | - diff --git a/docs/mobile/deeplink/callback-codes.zh.md b/docs/mobile/deeplink/callback-codes.zh.md deleted file mode 100644 index 3644e9b..0000000 --- a/docs/mobile/deeplink/callback-codes.zh.md +++ /dev/null @@ -1,35 +0,0 @@ -# 回传消息码 - -| id | 消息 | 备注 | -|:-------|:-------|:-------| -| 0 | success | | -| 10001 | Incorrect JSON format | | -| 10002 | Missing Action | | -| 10003 | Unknown Action | | -| 10004 | Missing ActionId | | -| 10005 | Incorrect DApp URL format | | -| 10006 | Incorrect CallbackUrl format | | -| 10007 | Empty DApp name | v1.0 可以为空 | -| 10008 | Version number not supported | | -| 10009 | Current network not supported | | -| 10010 | The URL is not supported to open TronLink | | -| 10011 | Unknown SignType | | -| 10012 | Incorrect Transaction format | | -| 10013 | Incorrect Method format | | -| 10014 | Incorrect Message format | | -| 10015 | Incorrect toAddress | | -| 10016 | No wallet created in TronLink | | -| 10017 | Incorrect fromAddress | | -| 10018 | Incorrect contactAddress | | -| 10019 | Incorrect chainId | | -| 10020 | Incorrect amount | | -| 10021 | The initiating address does not match the current wallet | | -| 10022 | incorrect loginAddress | | -| 10023 | System contract not support | | -| 10024 | Incorrect tokenId | | -| 10025 | TokenId & Contract address should not be exist together | | -| 300 | Transaction canceled | | -| 301 | Transaction executed in TronLink | | -| 302 | Broadcast failure - returned with incorrect info | | -| -1 | Unknown reason | | - diff --git a/docs/mobile/deeplink/login-auth.en.md b/docs/mobile/deeplink/login-auth.en.md deleted file mode 100644 index 625ae99..0000000 --- a/docs/mobile/deeplink/login-auth.en.md +++ /dev/null @@ -1,32 +0,0 @@ -# Login by TronLink - -```shell - // Tronlink-v4.11.0 - // Link - Login/Request Address -``` -```shell - - // The parameter of param is the protocol data in json format - // Note: json.toString needs to be encoded with urlencode - { - "url": "https://justlend.org/#/home", - "callbackUrl": "http://xxx/api/tron/v1/callback", - "dappIcon": "https://test/icon.png", - "dappName": "Test demo", - "protocol": "TronLink", - "version": "1.0", - "chainId": "0x2b6653dc", - "action": "login", - "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288" - } -``` -```shell - { - "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288", - "address": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "code": 0, - "id": 1780812177, - "message": "success" - } -``` diff --git a/docs/mobile/deeplink/login-auth.zh.md b/docs/mobile/deeplink/login-auth.zh.md deleted file mode 100644 index 55c21f5..0000000 --- a/docs/mobile/deeplink/login-auth.zh.md +++ /dev/null @@ -1,34 +0,0 @@ -# 登陆授权 - -使用Deeplink方式唤起钱包，并在钱包中选择获取钱包地址 - -```shell - // Tronlink-v4.11.0 - // 链接 - Login/Request Address -``` - -```shell - // param的参数为json格式的协议数据 - // 注意：json.toString后需要进行urlencode编码 - { - "url": "https://justlend.org/#/home", - "callbackUrl": "http://xxx/api/tron/v1/callback", - "dappIcon": "https://test/icon.png", - "dappName": "Test demo", - "protocol": "TronLink", - "version": "1.0", - "chainId": "0x2b6653dc", - "action": "login", - "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288" - } -``` -```shell - { - "actionId": "e5471a9c-b0f1-418b-8634-3de60d68a288", - "address": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "code": 0, - "id": 1780812177, - "message": "success" - } -``` \ No newline at end of file diff --git a/docs/mobile/deeplink/message-signing.en.md b/docs/mobile/deeplink/message-signing.en.md deleted file mode 100644 index 80473e1..0000000 --- a/docs/mobile/deeplink/message-signing.en.md +++ /dev/null @@ -1,33 +0,0 @@ -# Sign Message -```shell - // Tronlink-v4.11.0 - Sign message -``` -```shell - // request parameter - { - "url": "https://justlend.org/#/home", - "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", - "dappIcon": "https://test/icon.png", - "dappName": "Test demo", - "protocol": "TronLink", - "version": "1.0", - "chainId": "0x2b6653dc", - "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "signType": "signStr", - "message": "abc", - "action": "sign", - "actionId": "50554861-4861-41c4-adf3-abf36213f843" - } -``` -```shell - // callback parameter - { - "actionId": "50554861-4861-41c4-adf3-abf36213f843", - "code": 0, - "id": 2001871012, - "message": "success", - "signedData": "0xffcac5731d9f70a58e5126f44c34b9356ccb9bef53331e33ddab84bb829adc1b77df24362348f8d46e506b489b4af4496600799b173e708faf1b9db99da9d13c1b" - } -``` - diff --git a/docs/mobile/deeplink/message-signing.zh.md b/docs/mobile/deeplink/message-signing.zh.md deleted file mode 100644 index 436b0d6..0000000 --- a/docs/mobile/deeplink/message-signing.zh.md +++ /dev/null @@ -1,35 +0,0 @@ -# 消息签名 - -```shell - // Tronlink-v4.11.0 - // 链接 - Sign message -``` -```shell - // request parameter - { - "url": "https://justlend.org/#/home", - "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", - "dappIcon": "https://test/icon.png", - "dappName": "Test demo", - "protocol": "TronLink", - "version": "1.0", - "chainId": "0x2b6653dc", - "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "signType": "signStr", - "message": "abc", - "action": "sign", - "actionId": "50554861-4861-41c4-adf3-abf36213f843" - } -``` -```shell - // callback parameter - { - "actionId": "50554861-4861-41c4-adf3-abf36213f843", - "code": 0, - "id": 2001871012, - "message": "success", - "signedData": "0xffcac5731d9f70a58e5126f44c34b9356ccb9bef53331e33ddab84bb829adc1b77df24362348f8d46e506b489b4af4496600799b173e708faf1b9db99da9d13c1b" - } -``` - diff --git a/docs/mobile/deeplink/open-dapp.en.md b/docs/mobile/deeplink/open-dapp.en.md deleted file mode 100644 index 568d283..0000000 --- a/docs/mobile/deeplink/open-dapp.en.md +++ /dev/null @@ -1,20 +0,0 @@ -# Open DApp - -### Use DeepLink to launch TronLink and open DApp in the DApp Explorer - -```shell - // Tronlink-v4.10.0 - // Link - Open DApp -``` -```shell - - // The parameter of param is the protocol data in json format - // Note: json.toString needs to be encoded with urlencode - { - "url": "https://www.tronlink.org/", //target DApp - "action": "open", - "protocol": "tronlink", - "version": "1.0" - } -``` \ No newline at end of file diff --git a/docs/mobile/deeplink/open-dapp.zh.md b/docs/mobile/deeplink/open-dapp.zh.md deleted file mode 100644 index d2c8a76..0000000 --- a/docs/mobile/deeplink/open-dapp.zh.md +++ /dev/null @@ -1,18 +0,0 @@ -# 打开DApp -### 使用 DeepLink 方式唤起钱包，并在 DApp 浏览器中打开 DApp -```shell - // Tronlink-v4.10.0 - // 链接 - Open DApp -``` -```shell - // param的参数为json格式的协议数据 - // 注意：json.toString后需要进行urlencode编码 - { - "url": "https://www.tronlink.org/", //目标DApp - "action": "open", - "protocol": "tronlink", - "version": "1.0" - } -``` - diff --git a/docs/mobile/deeplink/open-wallet.en.md b/docs/mobile/deeplink/open-wallet.en.md deleted file mode 100644 index affe503..0000000 --- a/docs/mobile/deeplink/open-wallet.en.md +++ /dev/null @@ -1,18 +0,0 @@ -# Open Wallet - -### Launch TronLink wallet via DeepLink - -```shell - // Tronlink-v4.10.0 - // Link - Open Tronlink -``` -```shell - // The parameter of param is the protocol data in json format - // Note: json.toString needs to be encoded with urlencode - { - "action": "open", - "protocol": "tronlink", - "version": "1.0" - } -``` \ No newline at end of file diff --git a/docs/mobile/deeplink/open-wallet.zh.md b/docs/mobile/deeplink/open-wallet.zh.md deleted file mode 100644 index bb8d691..0000000 --- a/docs/mobile/deeplink/open-wallet.zh.md +++ /dev/null @@ -1,18 +0,0 @@ -# 打开钱包 - -### 使用 DeepLink 方式唤起钱包 -```shell - // Tronlink-v4.10.0 - // 链接 - Open Tronlink -``` -```shell - // param的参数为json格式的协议数据 - // 注意：json.toString后需要进行urlencode编码 - { - "action": "open", - "protocol": "tronlink", - "version": "1.0" - } -``` - diff --git a/docs/mobile/deeplink/transaction-signing.en.md b/docs/mobile/deeplink/transaction-signing.en.md deleted file mode 100644 index 9a15d6f..0000000 --- a/docs/mobile/deeplink/transaction-signing.en.md +++ /dev/null @@ -1,37 +0,0 @@ -# Sign Transaction - -```shell - // Tronlink-v4.11.0 - // Link - Sign transaction -``` - -```shell - // request parameter - { - "url": "https://justlend.org/#/home", - "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", - "dappIcon": "https://test/icon.png", - "dappName": "Test demo", - "protocol": "TronLink", - "version": "1.0", - "chainId": "0x2b6653dc", - "action": "sign", - "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "method": "transfer(address,uint256)", - "signType": "signTransaction", - "data": "{\"visible\":false,\"txID\":\"dcfaf2c2d75d91994f9a23623e905eaa7d74bc804fa5821640111ada3441376a\",\"raw_data\":{\"contract\":[{\"parameter\":{\"value\":{\"data\":\"a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c60200000000000000000000000000000000000000000000000000000000000000014\",\"owner_address\":\"41b42b84bad413dde093e27d01bb02ed9eede52c43\",\"contract_address\":\"41eca9bc828a3005b9a3b909f2cc5c2a54794de05f\"},\"type_url\":\"type.googleapis.com/protocol.TriggerSmartContract\"},\"type\":\"TriggerSmartContract\"}],\"ref_block_bytes\":\"84e1\",\"ref_block_hash\":\"1731d6450e11a03f\",\"expiration\":1670168865000,\"fee_limit\":100000000,\"timestamp\":1670168805340},\"raw_data_hex\":\"0a0284e122081731d6450e11a03f40e8d1c9eecd305aae01081f12a9010a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412740a1541b42b84bad413dde093e27d01bb02ed9eede52c43121541eca9bc828a3005b9a3b909f2cc5c2a54794de05f2244a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c6020000000000000000000000000000000000000000000000000000000000000001470dcffc5eecd30900180c2d72f\"}", - "actionId": "64fcdb39-2cfa-47f2-85bd-d7e8409809ed" - } -``` -```shell - // callback parameter - { - "actionId": "f5d9791a-c774-4684-805a-83784c0c86ff", - "code": 0, - "id": -799302342, - "message": "success", - "successful": true, - "transactionHash": "2fc49e560f648e5ecb455955d8778267ec1f257436425f62393b632c9a7a55ad" - } -``` diff --git a/docs/mobile/deeplink/transaction-signing.zh.md b/docs/mobile/deeplink/transaction-signing.zh.md deleted file mode 100644 index 6e2cb9d..0000000 --- a/docs/mobile/deeplink/transaction-signing.zh.md +++ /dev/null @@ -1,36 +0,0 @@ -# 交易签名 - -```shell - // Tronlink-v4.11.0 - // 链接 - Sign transaction -``` -```shell - // request parameter - { - "url": "https://justlend.org/#/home", - "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", - "dappIcon": "https://test/icon.png", - "dappName": "Test demo", - "protocol": "TronLink", - "version": "1.0", - "chainId": "0x2b6653dc", - "action": "sign", - "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "method": "transfer(address,uint256)", - "signType": "signTransaction", - "data": "{\"visible\":false,\"txID\":\"dcfaf2c2d75d91994f9a23623e905eaa7d74bc804fa5821640111ada3441376a\",\"raw_data\":{\"contract\":[{\"parameter\":{\"value\":{\"data\":\"a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c60200000000000000000000000000000000000000000000000000000000000000014\",\"owner_address\":\"41b42b84bad413dde093e27d01bb02ed9eede52c43\",\"contract_address\":\"41eca9bc828a3005b9a3b909f2cc5c2a54794de05f\"},\"type_url\":\"type.googleapis.com/protocol.TriggerSmartContract\"},\"type\":\"TriggerSmartContract\"}],\"ref_block_bytes\":\"84e1\",\"ref_block_hash\":\"1731d6450e11a03f\",\"expiration\":1670168865000,\"fee_limit\":100000000,\"timestamp\":1670168805340},\"raw_data_hex\":\"0a0284e122081731d6450e11a03f40e8d1c9eecd305aae01081f12a9010a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412740a1541b42b84bad413dde093e27d01bb02ed9eede52c43121541eca9bc828a3005b9a3b909f2cc5c2a54794de05f2244a9059cbb000000000000000000000000ed87a3ae2bf2ab8b95486a23f224487ad75c6020000000000000000000000000000000000000000000000000000000000000001470dcffc5eecd30900180c2d72f\"}", - "actionId": "64fcdb39-2cfa-47f2-85bd-d7e8409809ed" - } -``` -```shell - // callback parameter - { - "actionId": "f5d9791a-c774-4684-805a-83784c0c86ff", - "code": 0, - "id": -799302342, - "message": "success", - "successful": true, - "transactionHash": "2fc49e560f648e5ecb455955d8778267ec1f257436425f62393b632c9a7a55ad" - } -``` diff --git a/docs/mobile/deeplink/transfer.en.md b/docs/mobile/deeplink/transfer.en.md deleted file mode 100644 index 6bdebde..0000000 --- a/docs/mobile/deeplink/transfer.en.md +++ /dev/null @@ -1,39 +0,0 @@ -# Transfer - -```shell - // Tronlink-v4.11.0 - // Link - Transfer -``` - - -```shell - { - "url": "https://justlend.org/#/home", - "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", - "dappIcon": "https://test/icon.png", - "dappName": "Test demo", - "protocol": "TronLink", - "version": "1.0", - "chainId": "0x2b6653dc", - "memo": "Reward", - "from": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "to": "TXd9duqtcyyj4pBCKvXKNqmazxxDw5SdBa", - "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "tokenId": "0", - "contract": "", - "amount": "20", - "action": "transfer", - "actionId": "408170fc-7919-4459-be5e-05a9d4b4065e" - } -``` - -```shell - { - "actionId": "099482f0-ee12-4703-bb7b-2e9d8c7c61a1", - "code": 0, - "id": 1142367107, - "message": "success", - "transactionHash": "e8ffe9b92c771e66999732b810bf2493be389464191040d8666a26dc449fa5f0" - } -``` diff --git a/docs/mobile/deeplink/transfer.zh.md b/docs/mobile/deeplink/transfer.zh.md deleted file mode 100644 index 6ff786c..0000000 --- a/docs/mobile/deeplink/transfer.zh.md +++ /dev/null @@ -1,40 +0,0 @@ -# 转账 - -使用DeepLink方式唤起TronLink，并发送转账数据，在钱包中转账并广播 - -```shell - - // Tronlink-v4.11.0 - // 链接 - Transfer -``` -```shell - { - "url": "https://justlend.org/#/home", - "callbackUrl": "http://3.12.131.175:7777/api/tron/v1/callback", - "dappIcon": "https://test/icon.png", - "dappName": "Test demo", - "protocol": "TronLink", - "version": "1.0", - "chainId": "0x2b6653dc", - "memo": "Reward", - "from": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "to": "TXd9duqtcyyj4pBCKvXKNqmazxxDw5SdBa", - "loginAddress": "TSPrmJetAMo6S6RxMd4tswzeRCFVegBNig", - "tokenId": "0", - "contract": "", - "amount": "20", - "action": "transfer", - "actionId": "408170fc-7919-4459-be5e-05a9d4b4065e" - } -``` -```shell - { - "actionId": "099482f0-ee12-4703-bb7b-2e9d8c7c61a1", - "code": 0, - "id": 1142367107, - "message": "success", - "transactionHash": "e8ffe9b92c771e66999732b810bf2493be389464191040d8666a26dc449fa5f0" - } -``` - diff --git a/docs/plugin-wallet/active-requests/add-token.en.md b/docs/plugin-wallet/active-requests/add-token.en.md deleted file mode 100644 index 5f11a87..0000000 --- a/docs/plugin-wallet/active-requests/add-token.en.md +++ /dev/null @@ -1,138 +0,0 @@ -# Add Token - -**Overview** - -Buttons on DApps allow users to directly add the specified tokens to the asset list on their TronLink user extension. - -**Specification** - -**Example** - -```shell - const res = await tronWeb.request({ - method: 'wallet_watchAsset', - params: { - type: 'TRC20', - options: { - address: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t' - } - }, - }); -``` -**Parameters** - -```shell - - interface WatchAssetParams { - type: 'trc10' | 'trc20' | 'trc721'; - options: { - address: string; - symbol?: string; - decimals?: number; - image?: string; - } - } -``` - * method: wallet_watchAsset fixed string - - * params: WatchAssetParams, the specific parameters are as follows: - - * type: Only 'trc10', 'trc20', 'trc721' are supported now - - * options: - - * address: the contract address of the token or the token id, required - - * symbol: placeholder (currently unused), optional - - * decimals: placeholder (currently unused), optional - - * image: placeholder (currently unused), optional - - -**Returns** - -This method has no return value - -**Interaction** - -**Add TRC10 assets** - -```shell - - if (window.tronLink.ready) { - const tronweb = tronLink.tronWeb; - try { - tronweb.request({ - method: 'wallet_watchAsset', - params: { - type: 'trc10', - options: { - address: '1002000' - }, - }, - }); - } catch (e) {} - } -``` - -When the code is executed, a TronLink pop-up window for adding TRC10 assets will show up, and the user can click “Add” or “Cancel”. - -![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_0.jpg) - -After clicking "Add", users can see the added assets as shown in the following screen: - -![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_1.jpg) - -**Add TRC20 assets** - -```shell - - if (window.tronLink.ready) { - const tronweb = tronLink.tronWeb; - try { - tronweb.request({ - method: 'wallet_watchAsset', - params: { - type: 'trc20', - options: { - address: 'TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3' - }, - }, - }); - } catch (e) {} - } -``` -When the code is executed, a TronLink pop-up window for adding TRC20 assets will show up, and the user can click “Add” or “Cancel”. - -![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_2.jpg) - -After clicking “Add”, users can see the added assets as shown in the following screen: - -![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_3.jpg) - -**Add TRC721 asset** - -```shell - if (window.tronLink.ready) { - const tronweb = tronLink.tronWeb; - try { - tronweb.request({ - method: 'wallet_watchAsset', - params: { - type: 'trc721', - options: { - address: 'TVtaUnsgKXhTfqSFRnHCsSXzPiXmm53nZt' - }, - }, - }); - } catch (e) {} - } -``` -When the code is executed, a TronLink pop-up window for adding TRC721 will show up, and the user can click “Add” or “Cancel”. - -![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_4.jpg) - -After clicking “Add”, users can see the added assets as shown in the following screen: - -![image](../../images/tronlink-wallet-extension_request-tronlink-extension_add-token_img_5.jpg) diff --git a/docs/plugin-wallet/active-requests/add-token.zh.md b/docs/plugin-wallet/active-requests/add-token.zh.md deleted file mode 100644 index 1cb9471..0000000 --- a/docs/plugin-wallet/active-requests/add-token.zh.md +++ /dev/null @@ -1,144 +0,0 @@ -# 添加Token -**简介** - -DApp 提供按钮给用户， 直接将指定的 Token 添加到用户插件的资产展示列表中。 - -**技术规范** - -**代码示例** - -```shell - - const res = await tronWeb.request({ - method: 'wallet_watchAsset', - params: { - type: 'TRC20', - options: { - address: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t' - } - }, - }); -``` -**参数** - -```shell - - interface WatchAssetParams { - type: 'trc10' | 'trc20' | 'trc721'; - options: { - address: string; - symbol?: string; - decimals?: number; - image?: string; - } - } -``` - * method: wallet_watchAsset 固定的字符串 - - * params: WatchAssetParams，具体参数如下： - - * type: 目前只支持 'trc10', 'trc20', 'trc721' 三种 - - * options: - - * address: token 的合约地址 或者 token id, 必传 - - * symbol: 占位(目前未使用)，可选 - - * decimals: 占位(目前未使用)，可选 - - * image: 占位(目前未使用)，可选 - -**返回值** - -此方法没有返回值 - -**交互流程** - -**添加 TRC10 资产** - -```shell - - if (window.tronLink.ready) { - const tronweb = tronLink.tronWeb; - try { - tronweb.request({ - method: 'wallet_watchAsset', - params: { - type: 'trc10', - options: { - address: '1002000' - }, - }, - }); - } catch (e) {} - } -``` -代码执行时，TronLink 会弹出添加窗口，用户点击确定添加 TRC10 资产，或者取消添加。 - -![image](../../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_0.jpg) - -点击“添加”按钮，资产被添加到资产列表，如下图所示： - -![image](../../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_1.jpg) - - -**添加 TRC20 资产** - -```shell - - if (window.tronLink.ready) { - const tronweb = tronLink.tronWeb; - try { - tronweb.request({ - method: 'wallet_watchAsset', - params: { - type: 'trc20', - options: { - address: 'TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3' - }, - }, - }); - } catch (e) {} - } -``` -代码执行时，TronLink 会弹出添加窗口，用户点击确定添加 TRC20 资产，或者取消添加。 - -![image](../../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_2.jpg) - - -点击“添加”按钮，资产被添加到资产列表，如下图所示： - -![image](../../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_3.jpg) - - -**添加 TRC721 资产** - -```shell - - if (window.tronLink.ready) { - const tronweb = tronLink.tronWeb; - try { - tronweb.request({ - method: 'wallet_watchAsset', - params: { - type: 'trc721', - options: { - address: 'TVtaUnsgKXhTfqSFRnHCsSXzPiXmm53nZt' - }, - }, - }); - } catch (e) {} - } -``` -代码执行时，TronLink 会弹出添加窗口，用户点击确定添加 TRC721 资产，或者取消添加。 - -![image](../../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_4.jpg) - - -点击”添加”按钮，资产被添加到资产列表，如下图所示： - -![image](../../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_tian-jia-token_img_5.jpg) - - - diff --git a/docs/plugin-wallet/active-requests/connect-website.en.md b/docs/plugin-wallet/active-requests/connect-website.en.md deleted file mode 100644 index 7e617a6..0000000 --- a/docs/plugin-wallet/active-requests/connect-website.en.md +++ /dev/null @@ -1,57 +0,0 @@ -# Connect Website - -DEPRECATED - -The methods in this section are deprecated and are expected to be removed in a few releases. The TRON community is discussing new specifications, you can go to [TRON-TIP](https://github.com/tronprotocol/tips/issues/463) to participate in the discussion. - -**Connect Website** - -**Overview** - -TronLink supports TRX transfers, contract signature, authorization, etc. initiated by DApps. For security considerations, users are required to authorize the DApp to “connect website”. They can take further actions only after successful authorization. The DApp must first connect to the website, and wait for the user's permission before it can initiate a request for authorization. - -**Specification** - -**Example** - -```shell - const res = await tronWeb.request( - { - method: 'tron_requestAccounts', - params: { - websiteIcon: '', - websiteName: '', - }, - } - ) -``` -**Parameters** - -```shell - interface RequestAccountsParams { - websiteIcon?: string; - websiteName?: string; - } -``` - -**Returns** - -```shell - interface ReqestAccountsResponse { - code: 200 | 4000 | 4001, - message: string - } -``` -| Error Code | Description | Message | -|:-------|:-------|:-------| -| null | Wallet is locked | Empty string | -| 200 | The site has previously been allowed to connect | The site is already in the whitelist | -| 200 | The user approved the connection | User allowed the request. | -| 4000 | The same DApp has already initiated a request to connect to the website, and the pop-up window has not been closed | Authorization requests are being processed, please do not resubmit | -| 4001 | The user rejected connection | User rejected the request | - -**Interaction** - -After triggering ‘tron_requestAccounts‘, there will be a pop-up window asking for confirmation: - -![image](../../images/tronlink-wallet-extension_request-tronlink-extension_connect-website_img_0.jpg) diff --git a/docs/plugin-wallet/active-requests/connect-website.zh.md b/docs/plugin-wallet/active-requests/connect-website.zh.md deleted file mode 100644 index 04c9de3..0000000 --- a/docs/plugin-wallet/active-requests/connect-website.zh.md +++ /dev/null @@ -1,73 +0,0 @@ -# 连接网站 - -DEPRECATED - -本小节的方法已废弃，预计将在几个版本后移除。TRON 社区正在讨论新的规范，可以到 [TRON-TIP](https://github.com/tronprotocol/tips/issues/463) 参与讨论。 - -#### 连接网站 - -**简介** - -TronLink 提供外部发起 TRX 转账，合约签名，授权等功能，基于安全的考虑， 需要用户在关键操作前先对发起请求的 DApp 进行【连接网站】授权，在授权成功后才允许操作。 所以 DApp 要先进行【连接网站】操作，等待用户允许后，方能发起需要授权的请求。 - -**技术规范** - -**代码示例** - -```shell - - const res = await tronWeb.request( - { - method: 'tron_requestAccounts', - params: { - websiteIcon: '', - websiteName: '', - }, - } - ); -``` -**参数** - -```shell - - interface RequestAccountsParams { - websiteIcon?: string; - websiteName?: string; - } -``` - * method: tron_requestAccounts 固定的字符串 - - * params: RequestAccountParams类型，具体参数如下： - - * websiteIcon: DApp 网站的图标的网址, 具体会展示在用户已连接网站列表中 - - * websiteName: DApp 网站名称 - -**返回值** - -类型说明 - -```shell - - interface ReqestAccountsResponse { - code: 200 | 4000 | 4001, - message: string - } -``` - -| 返回码 | 描述 | 返回消息 | -|:-------|:-------|:-------| -| 无 | 钱包处于锁定状态 | 空字符串 | -| 200 | 网站此前已被用户允许连接 | The site is already in the whitelist | -| 200 | 用户同意连接 | User allowed the request. | -| 4000 | 当前请求前已经有同一个 DApp 发起了连接网站请求，并且弹窗仍未关闭 | Authorization requests are being processed, please do not resubmit | -| 4001 | 用户拒绝连接 | User rejected the request | - - -**交互流程** - -触发`tron_requestAccounts`之后，会打开连接确认的弹窗： - -![image](../../images/zh_cha-jian-qian-bao_zhu-dong-qing-qiu-tronlink-cha-jian-gong-neng_lian-jie-wang-zhan_img_0.jpg) - - diff --git a/docs/plugin-wallet/passive-messages/account-change.en.md b/docs/plugin-wallet/passive-messages/account-change.en.md deleted file mode 100644 index f135110..0000000 --- a/docs/plugin-wallet/passive-messages/account-change.en.md +++ /dev/null @@ -1,88 +0,0 @@ -# Account Change Message - -Message ID: `accountsChanged` - -**Overview** - -This message is generated when: - - 1. Users log in - - 2. Users switch accounts - - 3. Users lock accounts - - 4. The wallet is automatically locked after timeout - - - - -**Specification** - -**Example** - -```shell - - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action === "accountsChanged") { - // handler logic - console.log('got accountsChanged event', e.data) - } - }) -``` -**Returns** - -```shell - - - interface MessageEventAccountsChangedData { - isTronLink: boolean; - message: { - action: string; - data: { - address: string | boolean; - } - } - } -``` -**Return value example** - - 1. When users log in, the content of the message body is: - - - - -```shell - - - { - "data": { - "address": "TZ5XixnRyraxJJy996Q1sip85PHWuj4793" // Last selected account address - } - } -``` - 1. When users switch accounts, the content of the message body is: - - - - -```shell - { - "data": { - "address": "TRKb2nAnCBfwxnLxgoKJro6VbyA6QmsuXq" // Newly selected account address - } - } -``` - 1. When users lock accounts and the wallet is automatically locked due to timeout, the message body content is: - - - - -```shell - { - "data": { - "address": false - } - } -``` \ No newline at end of file diff --git a/docs/plugin-wallet/passive-messages/account-change.zh.md b/docs/plugin-wallet/passive-messages/account-change.zh.md deleted file mode 100644 index 018f5c3..0000000 --- a/docs/plugin-wallet/passive-messages/account-change.zh.md +++ /dev/null @@ -1,76 +0,0 @@ -# 账户改变消息 - -消息标识： `accountsChanged` - -**简介** - -以下情况会产生此消息 - - 1. 用户登陆 - - 2. 用户切换账号 - - 3. 用户锁定账号 - - 4. 钱包超时自动锁定 - -**技术规范** - -**代码示例** - -```shell - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action === "accountsChanged") { - // handler logic - console.log('got accountsChanged event', e.data) - } - }) -``` -**返回值** - -```shell - - interface MessageEventAccountsChangedData { - isTronLink: boolean; - message: { - action: string; - data: { - address: string | boolean; - } - } - } -``` -**返回值示例** - - 1. 用户登陆时，消息体内容为： - -```shell - - { - "data": { - "address": "TZ5XixnRyraxJJy996Q1sip85PHWuj4793" // 上次选择的账号地址 - } - } -``` - 1. 用户切换账号时，消息体内容为： - -```shell - - { - "data": { - "address": "TRKb2nAnCBfwxnLxgoKJro6VbyA6QmsuXq" // 新选择的账号地址 - } - } -``` - 1. 用户锁定和钱包超时自动锁定时，消息体内容为： - -```shell - - { - "data": { - "address": false - } - } -``` - diff --git a/docs/plugin-wallet/passive-messages/connect-success.en.md b/docs/plugin-wallet/passive-messages/connect-success.en.md deleted file mode 100644 index 039bd57..0000000 --- a/docs/plugin-wallet/passive-messages/connect-success.en.md +++ /dev/null @@ -1,31 +0,0 @@ -# Successful connection message - -Message ID: `connect` - -**Overview** - -Developers can monitor this message for connection changes. - -This message is generated when: - - 1. The DApp requests a connection, and the user confirms the connection in the pop-up window - - 2. Users connect to the website - - - - -**Specification** - -**Example** - -```shell - - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "connect") { - // handler logic - console.log('got connect event', e.data) - } - }) -``` \ No newline at end of file diff --git a/docs/plugin-wallet/passive-messages/connect-success.zh.md b/docs/plugin-wallet/passive-messages/connect-success.zh.md deleted file mode 100644 index feb4546..0000000 --- a/docs/plugin-wallet/passive-messages/connect-success.zh.md +++ /dev/null @@ -1,27 +0,0 @@ -# 连接网站成功消息 - -消息标识： `connect` - -**简介** - -开发者可以监听此消息来获取网络的改变。 - -以下情况会产生此消息： - - 1. DApp 请求连接，用户在弹窗中确定连接后 - - 2. 用户主动连接网站 - -**技术规范** - -**代码示例** - -```shell - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "connect") { - // handler logic - console.log('got connect event', e.data) - } - }) -``` diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages.en.md b/docs/plugin-wallet/passive-messages/deprecated-messages.en.md deleted file mode 100644 index 8d37b34..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages.en.md +++ /dev/null @@ -1,10 +0,0 @@ -# Messages to Be Deprecated - - 1. The user rejects connection: “rejectWeb” - - 2. The user disconnects from the website: “disconnectWeb” - - 3. The user accepts connection: “acceptWeb” - - 4. The user requests to connect to the website: “connectWeb” - diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages.zh.md b/docs/plugin-wallet/passive-messages/deprecated-messages.zh.md deleted file mode 100644 index b5de05d..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages.zh.md +++ /dev/null @@ -1,12 +0,0 @@ -# 即将废弃的消息 - -以下四个消息在未来4.x版本将会被废弃 - - 1. 用户拒绝连接消息`rejectWeb` - - 2. 用户断连网站消息`disconnectWeb` - - 3. 用户确定连接消息`acceptWeb` - - 4. 用户主动连接网站消息`connectWeb` - diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.en.md b/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.en.md deleted file mode 100644 index efa1cda..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.en.md +++ /dev/null @@ -1,25 +0,0 @@ -# User requests to connect to the website - -DEPRECATED - -Message ID: `connectWeb` - -This message is generated when: - - 1. The user requests to connect to the website. - - ![image](../../../images/tronlink-wallet-extension_receive-messages-from-tronlink_messages-to-be-deprecated_user-requests-to-connect-to-the-website_img_0.jpg) - - - - -Developers can get the connection request message by listening to it: - -```shell - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "connectWeb") { - // handler logic - console.log('got connectWeb event', e.data) - } - }) -``` diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md b/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md deleted file mode 100644 index 7fcd3cd..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md +++ /dev/null @@ -1,24 +0,0 @@ -# 用户主动连接网站消息 - -DEPRECATED - -消息标识： `connectWeb` - -以下情况会产生此消息 - - 1. 用户确定连接消息 - -![image](../../../images/zh_cha-jian-qian-bao_bei-dong-jie-shou-tronlink-cha-jian-de-xiao-xi_ji-jiang-fei-qi-de-xiao-xi_yong-hu-zhu-dong-lian-jie-wang-zhan-xiao-xi_img_0.jpg) - -开发者可以监听此消息来获取用户主动连接网站消息 - -```shell - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "connectWeb") { - // handler logic - console.log('got connectWeb event', e.data) - } - }) -``` - diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.en.md b/docs/plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.en.md deleted file mode 100644 index 258c67c..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.en.md +++ /dev/null @@ -1,25 +0,0 @@ -# User accepts connection - -DEPRECATED - -Message ID: `acceptWeb` - -This message is generated when: - - 1. The user accepts connection. - - ![image](../../../images/tronlink-wallet-extension_receive-messages-from-tronlink_messages-to-be-deprecated_user-accepts-connection_img_0.jpg) - - - - -Developers can get the connection acceptance message by listening to it: - -```shell - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "acceptWeb") { - // handler logic - console.log('got acceptWeb event', e.data) - } - }) -``` \ No newline at end of file diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.zh.md b/docs/plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.zh.md deleted file mode 100644 index 71d23c1..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.zh.md +++ /dev/null @@ -1,24 +0,0 @@ -# 用户确定连接消息 - -DEPRECATED - -消息标识： `acceptWeb` - -以下情况会产生此消息 - - 1. 用户确定连接消息 - - ![image](../../../images/zh_cha-jian-qian-bao_bei-dong-jie-shou-tronlink-cha-jian-de-xiao-xi_ji-jiang-fei-qi-de-xiao-xi_yong-hu-que-ding-lian-jie-xiao-xi_img_0.jpg) - -开发者可以监听此消息来获取用户确定连接消息 - -```shell - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "acceptWeb") { - // handler logic - console.log('got acceptWeb event', e.data) - } - }) -``` - diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages/user-disconnect.en.md b/docs/plugin-wallet/passive-messages/deprecated-messages/user-disconnect.en.md deleted file mode 100644 index e8f71e6..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages/user-disconnect.en.md +++ /dev/null @@ -1,27 +0,0 @@ -# User disconnects from the website - -DEPRECATED - -Message ID: `disconnectWeb` - -This message is generated when: - - 1. User actively disconnect from the website. - - ![image](../../../images/tronlink-wallet-extension_receive-messages-from-tronlink_messages-to-be-deprecated_user-disconnects-from-the-website_img_0.jpg) - - - - -Developers can get the disconnection message by listening to it: - -```shell - - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "disconnectWeb") { - // handler logic - console.log('got disconnectWeb event', e.data) - } - }) -``` \ No newline at end of file diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages/user-disconnect.zh.md b/docs/plugin-wallet/passive-messages/deprecated-messages/user-disconnect.zh.md deleted file mode 100644 index a33fef5..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages/user-disconnect.zh.md +++ /dev/null @@ -1,24 +0,0 @@ -# 用户断连网站消息 - -DEPRECATED - -消息标识： `disconnectWeb` - -以下情况会产生此消息 - - 1. 用户主动断接网站 - -![image](../../../images/zh_cha-jian-qian-bao_bei-dong-jie-shou-tronlink-cha-jian-de-xiao-xi_ji-jiang-fei-qi-de-xiao-xi_yong-hu-duan-lian-wang-zhan-xiao-xi_img_0.jpg) - -开发者可以监听此消息来获取用户主动断连消息 - -```shell - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "disconnectWeb") { - // handler logic - console.log('got disconnectWeb event', e.data) - } - }) -``` - diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.en.md b/docs/plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.en.md deleted file mode 100644 index 7174172..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.en.md +++ /dev/null @@ -1,25 +0,0 @@ -# User rejects connection - -DEPRECATED - -Message ID: `rejectWeb` - -This message is generated when: - - 1. The DApp requests a connection and the user rejects the connection in the pop-up window. - - ![image](../../../images/tronlink-wallet-extension_receive-messages-from-tronlink_messages-to-be-deprecated_user-rejects-connection_img_0.jpg) - - -Developers can get the connection rejection message by listening to it: - -```shell - - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "rejectWeb") { - // handler logic - console.log('got rejectWeb event', e.data) - } - }) -``` \ No newline at end of file diff --git a/docs/plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.zh.md b/docs/plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.zh.md deleted file mode 100644 index 31d4e60..0000000 --- a/docs/plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.zh.md +++ /dev/null @@ -1,23 +0,0 @@ -# 用户拒绝连接消息 - -DEPRECATED - -消息标识： `rejectWeb` - -以下情况会产生此消息： - - 1. DApp 请求连接，用户在弹窗中拒绝连接后 - -![image](../../../images/zh_cha-jian-qian-bao_bei-dong-jie-shou-tronlink-cha-jian-de-xiao-xi_ji-jiang-fei-qi-de-xiao-xi_yong-hu-ju-jue-lian-jie-xiao-xi_img_0.jpg) - -开发者可以监听此消息来获取用户拒绝连接消息 - -```shell - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "rejectWeb") { - // handler logic - console.log('got rejectWeb event', e.data) - } - }) -``` - diff --git a/docs/plugin-wallet/passive-messages/disconnect.en.md b/docs/plugin-wallet/passive-messages/disconnect.en.md deleted file mode 100644 index 64ae25f..0000000 --- a/docs/plugin-wallet/passive-messages/disconnect.en.md +++ /dev/null @@ -1,31 +0,0 @@ -# Disconnect website message - -Message ID: `disconnect` - -**Overview** - -Developers can monitor this message for connection changes. - -This message is generated when: - - 1. The DApp requests a connection, and the user rejects the connection in the pop-up window - - 2. Users disconnect from the website - - - - -**Specification** - -**Example** - -```shell - - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "disconnect") { - // handler logic - console.log('got connect event', e.data) - } - }) -``` diff --git a/docs/plugin-wallet/passive-messages/disconnect.zh.md b/docs/plugin-wallet/passive-messages/disconnect.zh.md deleted file mode 100644 index 947a5f8..0000000 --- a/docs/plugin-wallet/passive-messages/disconnect.zh.md +++ /dev/null @@ -1,28 +0,0 @@ -# 断开连接网站消息 - -消息标识： `disconnect` - -**简介** - -开发者可以监听此消息来获取网络的改变。 - -以下情况会产生此消息： - - 1. DApp 请求连接，用户在弹窗中拒绝连接后 - - 2. 用户主动断开连接网站 - -**技术规范** - -**代码示例** - -```shell - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "disconnect") { - // handler logic - console.log('got connect event', e.data) - } - }) -``` - diff --git a/docs/plugin-wallet/passive-messages/network-change.en.md b/docs/plugin-wallet/passive-messages/network-change.en.md deleted file mode 100644 index faab572..0000000 --- a/docs/plugin-wallet/passive-messages/network-change.en.md +++ /dev/null @@ -1,43 +0,0 @@ -# Network Change Message - -Message ID: `setNode` - -**Overview** - -Developers can monitor this message to know network changes - -This message is generated when: - - 1. When the user changes the network - - - - -**Specification** - -**Example** - -```shell - - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "setNode") { - // handler logic - console.log('got setNode event', e.data) - } - }) -``` -**Returns** - -```shell - - - { - "node": { - // Information about the current network - }, - "connectNode": { - // Node information of DApp chain - } - } -``` \ No newline at end of file diff --git a/docs/plugin-wallet/passive-messages/network-change.zh.md b/docs/plugin-wallet/passive-messages/network-change.zh.md deleted file mode 100644 index 845bc2e..0000000 --- a/docs/plugin-wallet/passive-messages/network-change.zh.md +++ /dev/null @@ -1,39 +0,0 @@ -# 网络改变消息 - -消息标识： `setNode` - -**简介** - -开发者可以监听此消息来获取网络的改变 - -以下情况会产生此消息 - - 1. 用户改变网络的时候 - -**技术规范** - -**代码示例** - -```shell - - window.addEventListener('message', function (e) { - if (e.data.message && e.data.message.action == "setNode") { - // handler logic - console.log('got setNode event', e.data) - } - }) -``` -**返回值** - -```shell - - { - "node": { - // 当前网络的信息 - }, - "connectNode": { - // dapp chain 的节点信息 - } - } -``` - diff --git a/mkdocs.yml b/mkdocs.yml index ca91f8a..f144b9c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,40 +59,13 @@ plugins: - Introduction: introduction.en.md - HD Wallets: hd-wallets.en.md - TronLink App: - # - Overview: mobile/index.en.md - Asset Management: mobile/asset-management.en.md - DeepLink: mobile/deeplink.en.md - # - Open Wallet: mobile/deeplink/open-wallet.en.md - # - Open DApp: mobile/deeplink/open-dapp.md - # - Login by TronLink: mobile/deeplink/login-auth.en.md - # - Transfer: mobile/deeplink/transfer.md - # - Sign Transaction: mobile/deeplink/transaction-signing.en.md - # - Sign Message: mobile/deeplink/message-signing.en.md - # - Result Code: mobile/deeplink/callback-codes.en.md - DApp Support: mobile/dapp-support.en.md - # - Overview: mobile/dapp-support.en.md - # - TronLink Integration: mobile/dapp-support/integrate-tronlink.md - # - DApp Explorer: mobile/dapp-support/dapp-browser.md - TronLink Wallet Extension: - # - Overview: plugin-wallet/index.md - Request TronLink Extension: plugin-wallet/active-requests.en.md - # - Overview: plugin-wallet/active-requests.en.md - # - Connect Website: plugin-wallet/active-requests/connect-website.en.md - # - Add Token: plugin-wallet/active-requests/add-token.en.md - Receive messages from TronLink: plugin-wallet/passive-messages.en.md - # - Overview: plugin-wallet/passive-messages.en.md - # - Account Change Message: plugin-wallet/passive-messages/account-change.en.md - # - Network Change Message: plugin-wallet/passive-messages/network-change.en.md - # - Successful connection message: plugin-wallet/passive-messages/connect-success.en.md - # - Disconnect website message: plugin-wallet/passive-messages/disconnect.en.md - # - Messages to Be Deprecated: - # - Overview: plugin-wallet/passive-messages/deprecated-messages.en.md - # - User rejects connection: plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.en.md - # - User disconnects from the website: plugin-wallet/passive-messages/deprecated-messages/user-disconnect.en.md - # - User accepts connection: plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.en.md - # - User requests to connect to the website: plugin-wallet/passive-messages/deprecated-messages/user-active-connect.en.md - DApp: - # - Overview: dapp/index.en.md - Start Developing: dapp/getting-started.en.md - Multi-Signature Transfer: dapp/multi-sign-transfer.en.md - Message Signature: dapp/message-signing.en.md @@ -103,47 +76,16 @@ plugins: site_name: TronLink 开发者文档 build: true nav: - # - 首页: index.zh.md - 介绍: introduction.zh.md - HD 钱包: hd-wallets.zh.md - 移动端: - # - 概述: mobile/index.zh.md - 资产管理: mobile/asset-management.zh.md - # - 概述: mobile/asset-management.zh.md - # - 自定义通证: mobile/asset-management/custom-tokens.zh.md - DeepLink: mobile/deeplink.zh.md - # - 概述: mobile/deeplink.zh.md - # - 打开钱包: mobile/deeplink/open-wallet.zh.md - # - 打开DApp: mobile/deeplink/open-dapp.zh.md - # - 登陆授权: mobile/deeplink/login-auth.zh.md - # - 转账: mobile/deeplink/transfer.zh.md - # - 交易签名: mobile/deeplink/transaction-signing.zh.md - # - 消息签名: mobile/deeplink/message-signing.zh.md - # - 回传消息码: mobile/deeplink/callback-codes.zh.md - DApp支持: mobile/dapp-support.zh.md - # - 概述: mobile/dapp-support.zh.md - # - 集成TronLink: mobile/dapp-support/integrate-tronlink.zh.md - # - DApp浏览器: mobile/dapp-support/dapp-browser.zh.md - 插件钱包: - # - 概述: plugin-wallet/index.zh.md - 主动请求TronLink插件功能: plugin-wallet/active-requests.zh.md - # - 概述: plugin-wallet/active-requests.zh.md - # - 连接网站: plugin-wallet/active-requests/connect-website.zh.md - # - 添加Token: plugin-wallet/active-requests/add-token.zh.md - 被动接收TronLink插件的消息: plugin-wallet/passive-messages.zh.md - # - 概述: plugin-wallet/passive-messages.zh.md - # - 账户改变消息: plugin-wallet/passive-messages/account-change.zh.md - # - 网络改变消息: plugin-wallet/passive-messages/network-change.zh.md - # - 连接网站成功消息: plugin-wallet/passive-messages/connect-success.zh.md - # - 断开连接网站消息: plugin-wallet/passive-messages/disconnect.zh.md - # - 即将废弃的消息: - # - 概述: plugin-wallet/passive-messages/deprecated-messages.zh.md - # - 用户拒绝连接消息: plugin-wallet/passive-messages/deprecated-messages/user-reject-connect.zh.md - # - 用户断连网站消息: plugin-wallet/passive-messages/deprecated-messages/user-disconnect.zh.md - # - 用户确定连接消息: plugin-wallet/passive-messages/deprecated-messages/user-confirm-connect.zh.md - # - 用户主动连接网站消息: plugin-wallet/passive-messages/deprecated-messages/user-active-connect.zh.md - DApp: - # - 概述: dapp/index.zh.md - 开始开发: dapp/getting-started.zh.md - 多签转账: dapp/multi-sign-transfer.zh.md - 消息签名: dapp/message-signing.zh.md