@abcwallet/packager 中文文档教程
ABCWallet Packager
用于轻松创建 ABCWallet 兼容离线包的打包器。
Installation
NPM
npm install @abcwallet/packager
Yarn
Yarn add @abcwallet/packager
Usage
Requirements
节点 10+
Examples
Pack files into an offline package.
首先,你需要打包你的 dapp 的资源,打包由你决定:
abcp pack -I 100 -H 127.0.0.1 -i test/public -o test/archive.zip
此外,您可以将每个选项放在一个 JSON 配置文件中以便重复使用:
abcp pack -c config.json
JSON 配置文件支持复杂的映射关系。
Upload offline package to Dapp Store.
您需要先设置环境变量 DSEMAIL 和 DSPASSWORD。 DSEMAIL 是您的 Dapp Store 帐户电子邮件。 DSPASSWORD 是您的 Dapp Store 帐户密码。
然后,您可以使用 Dapp Store 的网页或部署命令部署您的包:
abcp deploy -I 287 -i test/create_by_config.zip
这里您也可以重复使用打包的相同 JSON 配置文件使用的命令:
abcp deploy -c config.json
这会自动将离线包上传到Dapp Store,如果你使用某种ci progress,这将很有帮助。
Map Config
使用 JSON 配置文件,你可以为你的 dapp 设置一个复杂的映射关系:
一对多:
{
"pid": "1", // your dapp ID
"input": "./public", // your dapp public directory
"output": "./create_by_config.zip", // path of packed archive
"map": [ // one-to-one map
{
"from": ".", // the hold public dir
"to": "a.your-domain.com"
},
{
"from": ".", // the hold public dir
"to": "b.your-domain.com"
}
]
}
多对多:
{
"pid": "1", // your dapp ID
"input": "./public", // your dapp public directory
"output": "./create_by_config.zip", // path of packed archive
"map": [ // many-to-many map
{
"from": "./sub_dir_A_of_public",
"to": "a.your-domain.com"
},
{
"from": "./sub_dir_A_of_public",
"to": "b.your-domain.com"
}
]
}
Development
Code Style
我们使用一个稍微调整过的 standardjs 版本:https://github.com/BlockABC/eslint-config-blockabc
License
ABCWallet Packager
A packager for easily creating ABCWallet compatiable offline package.
Installation
NPM
npm install @abcwallet/packager
Yarn
Yarn add @abcwallet/packager
Usage
Requirements
Node 10+
Examples
Pack files into an offline package.
First, you need pack resources of your dapp, which should be packed is up to you:
abcp pack -I 100 -H 127.0.0.1 -i test/public -o test/archive.zip
Also, you may put every options in a JSON config file for reuse purpose:
abcp pack -c config.json
The JSON config file support complicated map relation.
Upload offline package to Dapp Store.
You need to set environment variable DSEMAIL and DSPASSWORD first. DSEMAIL is your Dapp Store account email. DSPASSWORD is your Dapp Store account password.
Then, you may deploy your package with the web page of Dapp Store or the deploy command:
abcp deploy -I 287 -i test/create_by_config.zip
Here you may also reuse the same JSON config file which pack command used:
abcp deploy -c config.json
this will upload offline package to Dapp Store automatically, it will be helpful if you use some sort of ci progress.
Map Config
With JSON config file you set a complicated map relation for your dapp:
one-to-many:
{
"pid": "1", // your dapp ID
"input": "./public", // your dapp public directory
"output": "./create_by_config.zip", // path of packed archive
"map": [ // one-to-one map
{
"from": ".", // the hold public dir
"to": "a.your-domain.com"
},
{
"from": ".", // the hold public dir
"to": "b.your-domain.com"
}
]
}
many-to-many:
{
"pid": "1", // your dapp ID
"input": "./public", // your dapp public directory
"output": "./create_by_config.zip", // path of packed archive
"map": [ // many-to-many map
{
"from": "./sub_dir_A_of_public",
"to": "a.your-domain.com"
},
{
"from": "./sub_dir_A_of_public",
"to": "b.your-domain.com"
}
]
}
Development
Code Style
We use a little tweaked version of standardjs: https://github.com/BlockABC/eslint-config-blockabc