小布荷包浏览器插件
1. 产品简介
小布荷包浏览器插件是一款集账户管理、数字资产功能于一体的先进的管理工具，为用户提供安全、便捷的数字资产存储和管理体验。它不仅支持账户的导入、创建与恢复，数字资产转移等功能，还具备了应用测集成小布荷包功能的对外能力，实现授权、签名和数据上链等操作，方便用户进行区块链操作，满足个性化的需求。
1.1. 应用场景
-
身份验证：可以用于身份验证，用户可以使用浏览器插件中的私钥签署交易或消息，以验证其身份，实现快速登陆。
-
智能合约操作：浏览器插件支持执行、调用智能合约。
-
数字身份证明和凭证：支持生成和管理数字身份证明、数字签名、凭证等。
-
开发者工具与集成：通过插件SDK，开发者可以轻松地与链进行交互。
1.2. 主要功能
账号管理
为用户提供身份的创建、更新及验证功能。用户可以使用浏览器插件自主生成区块链账户；也可以将已有账户对应的助记词、私钥等导入浏览器插件，恢复已有的区块链账号。
SDK功能
用户通过集成区块链浏览器插件SDK，可以实现与应用测的授权管理、签名、数据上链等功能，保护用户隐私，方便用户进行区块链操作，满足个性化的需求以 及便捷的区块链应用体验。
1.3. 产品特点
- 安全性：浏览器插件采用了先进的加密技术和安全协议，确保用户的私钥和数字资产得到充分的保护。
- 便捷操作：用户无需额外安装其他软件或应用，即可在浏览器中直接使用。这大大简化了用户的操作流程，提高了使用体验。
- 透明性：所有合约操作记录都存储在区块链上，公开透明，任何人都可以查看。这可以提高交易的透明度，降低欺诈和伪造的风险。
2. 用户使用手册
2.1. 安装说明
下载小布荷包浏览器插件
- 打开谷歌浏览器 更多工具-扩展程序- 打开开发者模式
- 点击加载已解压的扩展程序
- 解压zip包后，选择插件文件夹
- 导入后，点击浏览器右上角，出现扩展程序列表，点击红色框内的按键，会生成访问插件的快捷方式
- 点击上图的快捷方式进入创建账户页面
- 点击立即使用后，输入密码, 点击开始创建账户
- 点击复制助记词，粘贴到本地，选中我已了解，点击继续
- 按照助记词顺序依次点击单词，全部选完后，点击按钮“完成”，即可创建完成
2.2. 账户管理
导入账户
概述
导入私钥功能可用于将其他小布荷包浏览器插件中的账户导入到当前浏览器插件中。
步骤
- 在浏览器插件主界面，点击左上角选项后，显示左侧导航页。
- 点击“import”按钮后，显示导入账户弹窗。
- 在“导入私钥串”输入框中，粘贴您的私钥。
- 点击“导入”。
注意事项
- 请确保您输入的私钥正确无误。如果私钥错误，您将无法导入账户。
- 导入私钥后，您将拥有对该账户的完全控制权。请妥善保管您的私钥。
创建账户
概述
创建账户功能可用于创建一个新的区块链账户。
步骤
- 在浏览器插件主界面，点击右上角选项后，显示左侧导航页。
- 点击“create”按钮后，显示创建账户弹窗。
- 在“创建账户名称”输入框中，输入您的账户名，也可用浏览器插件默认给出的名称。
- 点击“创建”。
注意事项
- 创建 账户后，需要及时备份该账户的私钥。请妥善保管您的私钥。
恢复账户
概述
助记词恢复账户功能可以让您通过助记词恢复丢失访问权限的账户
步骤
- 在浏览器插件安装后的创建账户页面，锁定页，点击“使用账户助记词恢复您的账户”，进入到恢复账户页面。
- 在提供的字段中输入您的助记词和密码。
- 点击“导入钱包”。
注意事项
- 助记词是至关重要的信息。如果您丢失了助记词，将无法恢复账户。因此，请务必将助记词存储在安全的地方。
导出私钥
概述
导出私钥功能可以让您将浏览器插件中账户的私钥导出为文本文件。私钥是访问区块链账户的唯一凭证，需要妥善保管。
步骤
- 在浏览器插件主界面，点击右上角选项后，显示账户中心页面。
- 点击“ 导出私钥”，显示输入密码弹窗，输入正确的密码后，窗口会显示您的私钥串
- 点击“完成”复制您的私钥。
注意事项
-
私钥是您访问区块链账户的唯一凭证。请务必妥善保管您的私钥，不要将其与他人分享。
-
导出私钥后，您将拥有对该账户的完全控制权。请谨慎使用此功能。
2.3. 高级设置
国际化切换
概述
小布荷包浏览器插件的国际化切换功能可以让您更改浏览器插件界面的语言（中、英）。
步骤
- 在浏览器插件主界面，点击左上角选项后，显示左侧导航页，点击设置
- 进入到设置页后，点击语言，进行语言切换
自定义网络
概述
浏览器插件的自定义网络功能可以让您添加自定义网络到您的插件中。这对于您想使用浏览器插件连接默认不支持的区块链很有帮助。
步骤
- 点击右上角“网络”，显示网络列表窗口，点击“添加网络”后进入添加页面
- 进入到设置页后，点击语言，进行语言切换
- 输入以下信息：
- 网络名称
- 新的 RPC URL
- 链 ID
- 货币符号
- 区块浏览器 URL
- 点击“保存”按钮。
注意事项
-
请确保您为要添加的网络输入了正确的信息。如果您输入了错误的信息，您可能无法使用浏览器插件连接该网络。
-
添加自定义网络可能存在风险。只添加您确信安全和信誉良好的网络。
3. 接口使用说明
如果您想集成小布荷包浏览器插件到您的web应用，使用小布荷包对外提供的能力，请参照此API文档进行使用。
环境依赖
- 从 Node.js官网下载并安装 Node.js（版本为8.1.7或以上）。
# 若已安装，请通过命令查看版本：
node -v
检测插件是否安装
if (typeof window.Metapocket !== 'undefined' ) {
console.log('Metapocket is installed!');
}
授权
-
接口说明
通过调用该方法可以将区块链账户对应用侧进行授权。当您在应用侧上首次链接小布荷包时，会触发小布荷包的授权页面。完成授权后，小布荷包与应用侧的链接状态将保持3天。如果状态过期，当你再次访问应用侧时，会再次触发小布荷包的授权界面。
-
调用方法
Metapocket.getAccount() -
响应数据
参数 类型 描述 args.addressString 区块链账户地址 args.publicString 区块链账户公钥 -
示例代码
const Metapocket = window.Metapocket
Metapocket.getAccount(function (result) {
})
签名
-
接口说明
通过调用该方法可以支持应用侧传入消息内容，让小布荷包对其签名。调用该方法后会唤起小布荷包，并展示要签名的内容，操作者签名后会返回原始消息内容、签名账户公钥、签名串等。
-
调用方法
Metapocket.signMessage(args) -
请求参数
参数 类型 描述 args.messageString 必填，待签名数据 -
响应数据
参数 类型 描述 args.addressString 区块链账户地址 args.publicString 区块链账户公钥 args.signDataString 签名数据 -
示例代码
const Metapocket = window.Metapocket
Metapocket.signMessage({
message: "<String requiring signature>"
}, function(result) {
})
数据上链
-
接口说明
通过调用该方法可以支持应用侧传入blob待签数据，让小布荷包对其签名上链。调用该方法后会唤起小布荷包，并展示要签名的内容，操作者签名后会返回原始消息内容、签名账户公钥、签名串等。
-
调用方法
Metapocket.signBlob(args) -
请求参数
参数 类型 描述 args.blobString 必填，待签名数据 -
响应数据
参数 类型 描述 args.addressString 区块链账户地址 args.publicString 区块链账户公钥 args.signDataString 签名数据 -
示例代码
const Metapocket = window.Metapocket
Metapocket.signBlob({
blob: "<Blob requiring signature>"
}, function(result) {
})
监听账户切换
-
接口说明
调用该方法可以在切换用户时，返回切换后账户的地址
-
调用方法
Metapocket.on('switchAccount') -
响应数据
参数 类型 描述 args.addressString 区块链账户地址 -
示例代码
const Metapocket = window.Metapocket
Metapocket.on('switchAccount', function(result) {
})