# pier

**Repository Path**: bluarry/pier

## Basic Information

- **Project Name**: pier
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-18
- **Last Updated**: 2024-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Pier

![build](https://github.com/meshplus/pier/workflows/build/badge.svg)
[![codecov](https://codecov.io/gh/meshplus/pier/branch/master/graph/badge.svg)](https://codecov.io/gh/meshplus/pier)

## Build

Using the follow command to install necessary tools.

```bash
make prepare
```

And then install pier using the following command.

```bash
make install
```

## Initialization

Using the follow command to initialize pier.
```bash
pier init
```
Default repo path is `~/.pier`. If you want to specify the repo path, you can use `--repo` flag.

```bash
pier init --repo=$HOME/.pier
```

After initializing pier, it will generate the follow directory:

```
~/.pier
├── pier.toml
├── key.json

```

## Configuration

```toml
title = "pier"

[port]
pprof = 44555

[log]
level = "debug"
dir = "logs"
filename = "pier.log"
report_caller = false

[bitxhub]
addr = "localhost:60011"
validators = [
      "0x000f1a7a08ccc48e5d30f80850cf1cf283aa3abd",
      "0xe93b92f1da08f925bdee44e91e7768380ae83307",
      "0xb18c8575e3284e79b92100025a31378feb8100d6",
      "0x856E2B9A5FA82FD1B031D1FF6863864DBAC7995D",
]

[appchain]
plugin = "fabric-client-1.4.so"
config = "fabric"
```

`port.pprof`: the pprof server port

`log.level`: log level: debug, info, warn, error, fatal

`bitxhub.addr`: bitxhub grpc server port

`bitxhub.validators`: bitxhub validator's addresses

`appchain.plugin`: relative path in pier repo of appchain plugin

`appchain.config`: relative path of appchain config directory

## Usage

More details about usage is in [Pier handbook](https://github.com/meshplus/pier/wiki/Pier%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3)

## License

The Pier library (i.e. all code outside of the cmd and internal directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the LICENSE.LESSER file.

The Pier binaries (i.e. all code inside of the cmd and internal directory) is licensed under the GNU General Public License v3.0, also included in our repository in the LICENSE file.