Pier命令行¶

pier命令有多组子命令，其作用是与应用链或中继链交互，pier命令描述如下：

NAME:
   Pier - Manipulate the crosschain node

USAGE:
   pier [global options] command [command options] [arguments...]

VERSION:
   0.0.0

COMMANDS:
   appchain    Command about appchain in bitxhub
   client      Command about appchain in pier
   id          Get appchain id
   init        Initialize pier core local configuration
   config      Initialize pier plugins configuration
   interchain  Query interchain info
   p2p         Command about p2p
   rule        Command about rule
   start       Start a long-running daemon process
   version     Show version about ap
   proposals   proposals manage command
   show        Show pier key from repo
   help, h     Shows a list of commands or help for one command

参数解释

--repo：可选参数，指定pier节点配置文件所在目录，如果不指定，默认使用$HOME/.bitxhub目录。
--tls：可选参数，用于pier节点与bitxhub进行tls加密传输。如果不指定，默认为false。

 GLOBAL OPTIONS:
   --repo value   Pier repository path
   --tls          enable tls between pier and bitxhub or not
   --help, -h     show help
   --version, -v  print the version

子命令描述¶

pier appchain¶

pier appchain命令用于中继模式下，跨链网关Pier向中继链bitXHub实现应用链相关信息的注册、更新、变更等操作。

用法

NAME:
   Pier appchain - Command about appchain in bitxhub

USAGE:
   Pier appchain command [command options] [arguments...]

COMMANDS:
   method    Command about appchain method
   register  Register pier to bitxhub
   update    update appchain in bitxhub
   activate  activate appchain in bitxhub
   logout    logout appchain in bitxhub
   get       Get appchain info

OPTIONS:
   --help, -h  show help

具体描述

pier appchain具体描述与使用示例参考中继模式管理。

pier client¶

pier client命令用于直连模式的应用链管理。

用法

NAME:
   Pier client - Command about appchain in pier

USAGE:
   Pier client command [command options] [arguments...]

COMMANDS:
   register  Register appchain in pier
   update    Update appchain in pier
   audit     Audit appchain in pier
   get       Get appchain info
   rule      register appchain validation rule

OPTIONS:
   --help, -h  show help

具体描述

pier appchain具体描述与使用示例参考直连模式管理。

pier id¶

pier id命令用于获取所绑定的应用链地址。

用法

NAME:
   pier id - Get appchain id

USAGE:
   pier id [arguments...]

具体描述

样例：

$ pier --repo $HOME/.pier1 id 
# 控制台输出
0xfF8199Fae48C808b45667DA0CcaAEe839B1a10Cb

pier init¶

pier init命令用于初始化pier相关配置。如生成公私钥、ca证书等。

用法

NAME:
   Pier init - Initialize pier core local configuration

USAGE:
   Pier init command [command options] [arguments...]

COMMANDS:
   relay   Initialize pier relay mode configuration
   direct  Initialize pier direct mode configuration
   union   Initialize pier union mode configuration

OPTIONS:
   --http-port value    Specify http port (default: 44544)
   --pprof-port value   Specify pprof port (default: 44555)
   --enable-tls         Enable TLS or not
   --tlsca value        Specify TLS CA certificate path (default: "certs/ca.pem")
   --common-name value  Specify common name to verify (default: "localhost")
   --ha value           Specify if pier will run in single mode or high availability mode (default: "single")
   --help, -h           show help

具体描述

参数解释

--http-port：可选参数，指定监听的http端口号，默认为44544。
--pprof-port：可选参数，指定pprof的端口号，默认为44555.
--enable-tls：可选参数，是否进行TLS加密传输，默认为false。
--tlsca ：可选参数，TLS CA路径，默认为certs/ca.pem。
--common-name ：可选参数，指定ca证书的域名。默认为localhost。
--ha：可选参数，选择网关是否高可用，高可用功能为商业版本，默认只有单个网关。

pier init delay¶

中继模式网关初始化，命令参数如下：

NAME:
   Pier init relay - Initialize pier relay mode configuration

USAGE:
   Pier init relay [command options] [arguments...]

OPTIONS:
   --addrs value       Specify bitxhub nodes' address (default: "localhost:60011", "localhost:60012", "localhost:60013", "localhost:60014")
   --quorum value      Specify the quorum number of BitXHub (default: 2)
   --validators value  Specify validators of bitxhub (default: "0x000f1a7a08ccc48e5d30f80850cf1cf283aa3abd", "0xe93b92f1da08f925bdee44e91e7768380ae83307", "0xb18c8575e3284e79b92100025a31378feb8100d6", "0x856E2B9A5FA82FD1B031D1FF6863864DBAC7995D")

具体描述

参数解释

--addrs：可选参数，指定bixhub各节点地址及端口号。
--quorum：可选参数，指定bixhub集群的quorum个数，与具体共识算法与节点规模相关。
--validators：可选参数，指定bitxhub管理员节点地址。

pier init direct¶

直连模式网关初始化，命令参数如下：

NAME:
   Pier init direct - Initialize pier direct mode configuration

USAGE:
   Pier init direct [command options] [arguments...]

OPTIONS:
   --peers value  Specify counter party peers to connect

具体描述

参数解释

--peers：必选参数，指定直连模式下pier的网络信息（包含自己）。

样例：

其中地址为pier启动时所在地址，端口号可任意指定可用端口，

# 初始化pier1相关配置，配置文件目录为$HOME/.pier1

$ PID1=$(pier --repo .pier1 p2p id)
$ PID2=$(pier --repo .pier1 p2p id)

$ pier --repo .pier1 init direct --peers /ip4/127.0.0.1/tcp/3001/p2p/$PID1 --peers /ip4/127.0.0.1/tcp/3002/p2p/$PID2

Pier init union¶

大规模模式下的初始化配置，命令如下：

NAME:
   Pier init union - Initialize pier union mode configuration

USAGE:
   Pier init union [command options] [arguments...]

OPTIONS:
   --addrs value       Specify bitxhub nodes' address (default: "localhost:60011", "localhost:60012", "localhost:60013", "localhost:60014")
   --connectors value  Specify the remote union peers to connect

具体描述

参数解释

--addrs：可选参数，指定bixhub各节点地址及端口号。
--connectors：必选参数，指定大规模模式下pier的网络信息（包含自己）。

样例：

其中地址为pier启动时所在地址，端口号可任意指定可用端口，

# 初始化pier1相关配置，配置文件目录为$HOME/.pier1

$ PID1=$(pier --repo .pier1 p2p id)
$ PID2=$(pier --repo .pier1 p2p id)

$ pier --repo .pier1 init union --peers /ip4/127.0.0.1/tcp/3001/p2p/$PID1 --peers /ip4/127.0.0.1/tcp/3002/p2p/$PID2

pier config¶

pier config命令用于配置应用链相关信息。

用法

NAME:
   Pier config - Initialize pier plugins configuration

USAGE:
   Pier config command [command options] [arguments...]

COMMANDS:
   fabric    Initialize pier and fabric plugin configuration
   ethereum  Initialize pier and ethereum plugin configuration

OPTIONS:
   --redownload  Re-download plugin or not
   --help, -h    show help

具体描述

参数解释

--redownload：可选参数，是否重新下载插件，默认为true。

子命令

pier config fabric¶

配置fabric插件相关配置信息，并下载pier-client-fabric二进制文件，命令描述如下：

NAME:
   Pier config fabric - Initialize pier and fabric plugin configuration

USAGE:
   Pier config fabric [command options] [arguments...]

OPTIONS:
   --crypto-config value  Specify the path to crypto-config directory
   --config value         Specify the path to fabric config.yaml
   --event-filter value   Specify the event filter on fabric chaincode
   --username value       Specify the username to invoke fabric chaincode
   --ccid value           Specify chaincode id to invoke
   --channel-id value     Specify channel id
   --org value            Specify the organization

参数解释

--crypto-config：必选参数，指定fabric的文件目录，一般与repo目录一致。
--config：可选参数，指定fabric的config.yaml文件目录，默认在$repo/fabric目录下。
--event-filter：可选参数，根据eventName过滤所需的事件。
--username：可选参数，指定调用合约的用户名，默认为Admin。
--ccid：可选参数，CCID 应匹配fabric的peer节点上链码的包名。
--channel-id：可选参数，fabric链码部署所在的通道名。
--org：可选参数，fabric上指定的peer节点所属的组织。

样例：

# 注意，由于安装包的地址为github，下载可能较慢，可以重试几次或通过设置代理
$ pier --repo .pier2 config fabric --crypto-config $(pwd)/.pier2

Start downloading https://github.com/meshplus/pier-client-fabric/releases/download/v1.11.1/fabric-client-v1.11.1-darwin
Finish downloading https://github.com/meshplus/pier-client-fabric/releases/download/v1.11.1/fabric-client-v1.11.1-darwin

pier config ethereum¶

配置ethereum插件相关配置信息，并下载pier-client-ethereum二进制文件，命令描述如下：

NAME:
   Pier config ethereum - Initialize pier and ethereum plugin configuration

USAGE:
   Pier config ethereum [command options] [arguments...]

OPTIONS:
   --addr value          Specify ethereum websocket address
   --broker value        Specify ethereum broker contract address
   --key value           Specify the ethereum key to sign the transaction
   --password value      Specify the password of the key
   --min-confirm value   Specify minimum blocks to confirm the transaction (default: 0)
   --transfer value      Specify the transfer contract address
   --data-swapper value  Specify the data swapper contract address

参数解释

--addr：以太坊的websocket地址，如果是自己搭建的私链，一般为ws://localhost:8546。
--broker：必选参数，broker合约部署地址。
--key：以太坊用于交易签名的账户私钥。默认为repo目录下的account.key，如果是自己搭建的私链，可以将datadir/keystore下的私钥复制到account.key中。
--password：以太坊账户密码。
--min-confirm：最小确认数，用于本地测试建议设置为0。
--transfer：transfer合约地址。
--data-swapper：data swapper合约地址。

样例：

# 注意，由于安装包的地址为github，下载可能较慢，可以重试几次或通过设置代理
$ pier --repo .pier2 config ethereum --broker 0xFb23Af09e3E8D83fd5575De9558920Bf351F05E8 --addr ws://localhost:8546 --key account.key --password password --min-confirm 0

Start downloading https://github.com/meshplus/pier-client-ethereum/releases/download/v1.11.2/eth-client-v1.11.2-darwin
Finish downloading https://github.com/meshplus/pier-client-ethereum/releases/download/v1.11.2/eth-client-v1.11.2-darwin

pier interchain¶

pier interchain命令用于查询应用链的跨链交易信息。

用法

NAME:
   Pier interchain - Query interchain info

USAGE:
   Pier interchain command [command options] [arguments...]

COMMANDS:
   ibtp  Query ibtp by id

OPTIONS:
   --key value  Specific key.json path
   --help, -h   show help

具体描述

参数解释

--key：必选参数指定pier的key.json文件。

子命令

Pier interchain ibtp¶

NAME:
   Pier interchain ibtp - Query ibtp by id

USAGE:
   Pier interchain ibtp [command options] [arguments...]

OPTIONS:
   --id value  Specific ibtp id

样例：

$ pier --repo $HOME/.pier1 interchain --key $HOME/.pier1/key.json ibtp --id 0xfF8199Fae48C808b45667DA0CcaAEe839B1a10Cb-0x23Fb0E7eF676467563d37D820F1b1Fddb0f9a2E1-1

# 控制台输出
INFO[16:52:41.917] Establish connection with bitxhub localhost:60013 successfully  module=rpcx
Tx hash: 0x82d3434e0a295B22A8e55884FEdd137d19e8cBDc32d5B593AD6D9AFB5cf59600
tx:<from:<RawAddress:[255 129 153 250 228 140 128 139 69 102 125 160 204 170 238 131 155 26 16 203] Address:"" > to:<RawAddress:[0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 10] Address:"" > timestamp:1638435054429909000 transaction_hash:<RawHash:[130 211 67 78 10 41 91 34 168 229 88 132 254 221 19 125 25 232 203 220 50 213 181 147 173 109 154 251 92 245 150 0] Hash:"" > IBTP:<from:"0xfF8199Fae48C808b45667DA0CcaAEe839B1a10Cb" to:"0x23Fb0E7eF676467563d37D820F1b1Fddb0f9a2E1" index:1 timestamp:1638435054428680000 proof:"k\206\262s\3774\374\341\235k\200N\377Z?WG\255\244\352\242/\035I\300\036R\335\267\207[K" payload:"\022\221\001\n*0x5bFe03Dbd09817d4957693f672cc31A133Bb6084\022*0xA5dD12E27Ee5E79cE0B50adb376414351C8eea5f\032\020interchainCharge\"\001A\"\001B\"\002102\000:\022interchainRollbackB\001AB\00210" > nonce:4 signature:"T)\313\333~\316f\372.\010\235\234\222J\314@<\202\260\243\367b\035\016\366\326y\3515\020\222\256$\010\314\035/\271H\217|~\302\233\353b\275\267ir\t\242\376\224\307q\217l\232\037DP\n\317\000" extra:"1" > tx_meta:<block_hash:"\326{90^\355a\236\342\235i\302\374+\352VI\030\242\211\335x\371w\221>(\254%o\212\222" block_height:14 >

pier p2p¶

pier p2p命令用于直连模式下pier网络通信的pid。

用法

NAME:
   Pier p2p - Command about p2p

USAGE:
   Pier p2p command [command options] [arguments...]

COMMANDS:
   id  get pier unique id in p2p network

具体描述

样例：

# 初始化pier1相关配置，配置文件目录为$HOME/.pier1
$ pier --repo $HOME/.pier1 p2p id 

#控制台输出
QmNpQvh8Lm7gwt3sDqwJ1pgNn6taJLqdgtRVyZWhsD5bND

pier rule¶

pier rule命令用于中继模式下pier向中继链部署应用链验证规则。

用法

NAME:
   Pier rule - Command about rule

USAGE:
   Pier rule command [command options] [arguments...]

COMMANDS:
   deploy  Deploy validation rule
   update  update master rule
   logout  logout validation rule

OPTIONS:
   --help, -h  show help

具体描述

pier rule具体描述与使用示例参考直连模式管理的部署验证规则模块。

pier start¶

pier start命令用于启动pier。

用法

NAME:
   pier start - Start a long-running daemon process

USAGE:
   pier start [arguments...]

具体描述

样例：

$ pier --repo $HOME/.pier1 start

# 控制台输出
Pier version: v1.11.2-HEAD-ed2f786
App build date: 2021-12-01T14:50:14
System version: darwin/amd64
Golang version: go1.15.13

INFO[17:07:29.150] Establish connection with bitxhub localhost:60013 successfully  module=app
2021-12-02T17:07:29.171+0800 [DEBUG] plugin: starting plugin: path=/bin/sh args="[sh -c /Users/liruoxin/testRelay/release1.6/eth1/plugins/eth-client]"
2021-12-02T17:07:29.178+0800 [DEBUG] plugin: plugin started: path=/bin/sh pid=74023
2021-12-02T17:07:29.178+0800 [DEBUG] plugin: waiting for RPC address: path=/bin/sh
2021-12-02T17:07:29.283+0800 [DEBUG] plugin.sh: 2021-12-02T17:07:29.283+0800 [DEBUG] client: plugin address: network=unix address=/var/folders/xr/pnhf9j6n2k5_fysm6s0xkgt00000gn/T/plugin718241634
2021-12-02T17:07:29.283+0800 [DEBUG] plugin: using plugin: version=4
2021-12-02T17:07:29.284+0800 [TRACE] plugin.stdio: waiting for stdio data
2021-12-02T17:07:29.287+0800 [DEBUG] plugin.sh: 2021-12-02T17:07:29.287+0800 [INFO ] client: Basic appchain info: broker address=0xFb23Af09e3E8D83fd5575De9558920Bf351F05E8 ethereum node ip=ws://127.0.0.1:8546
2021-12-02T17:07:29.416+0800 [DEBUG] plugin.sh: 2021-12-02T17:07:29.416+0800 [INFO ] client: ContractABI: addr=0x5bfe03dbd09817d4957693f672cc31a133bb6084 name=transfer.abi
Client Type: ethereum
Pprof on localhost:44555
…………

pier version¶

pier version命令用于查询版本号。

用法

NAME:
   pier version - Show version about ap

USAGE:
   pier version [arguments...]

具体描述

样例：

$ pier --repo $HOME/.pier1 version

Pier version: dev-release-1.11-e1e7c14
App build date: 2021-12-01T17:50:14
System version: darwin/amd64
Golang version: go1.15.13

pier propsals¶

pier proposals命令用于撤销指定的提案。

用法

NAME:
   Pier proposals - proposals manage command

USAGE:
   Pier proposals command [command options] [arguments...]

COMMANDS:
   withdraw  withdraw a proposal

子命令

Pier proposals withdraw¶

NAME:
   Pier proposals withdraw - withdraw a proposal

USAGE:
   Pier proposals withdraw [command options] [arguments...]

OPTIONS:
   --admin-key value  Specific admin key path
   --id value         proposal id
   --reason value     Specify governance reason

样例

当想要撤销某个提案时（如注册应用链的提案）使用如下命令。其中，proposal id 为想要撤销的提案号，提案生成参考中继模式应用链管理。

# 应用链所在网关撤销提案
$ pier --repo $(pwd) proposals withdraw --admin-key ./key.json --id 0x450884c9F7fdFc72E2bC1245306d15dE1750A880-0 --reason "withdraw proposal"

# 撤销提案后，在中继链查询提案状态可以看到提案状态为：withdrawn by the proposal sponsor
$ bitxhub client governance proposal query -id 0x450884c9F7fdFc72E2bC1245306d15dE1750A880-0
========================================================================================
Id                                            ManagedObjectId               Type         EventType  Status  A/R  IE/AE/TE  Special/Super  CreateTime           Description  EndReason
--                                            ---------------               ----         ---------  ------  ---  --------  -------------  ----------           -----------  ---------
0x450884c9F7fdFc72E2bC1245306d15dE1750A880-0  did:bitxhub:fabricappchain:.  AppchainMgr  register   reject  0/0  4/4/3     false/false    1643088788665643000               withdrawn by the proposal sponsor
========================================================================================
* A/R：approve num / reject num
* IE/AE/TE：the total number of electorate at the time of the initial proposal / the number of available electorate currently /the minimum threshold for votes to take effect
* Special/Super：is special proposal / is super admin voted