pier

package module
v1.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 7, 2022 License: GPL-3.0 Imports: 2 Imported by: 0

README

Pier

build codecov

Build

Using the follow command to install necessary tools.

make prepare

And then install pier using the following command.

make install

Initialization

Using the follow command to initialize pier.

pier init

Default repo path is ~/.pier. If you want to specify the repo path, you can use --repo flag.

pier init --repo=$HOME/.pier

After initializing pier, it will generate the follow directory:

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

Configuration

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

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.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// CurrentCommit current git commit hash
	CurrentCommit = ""
	// CurrentBranch current git branch
	CurrentBranch = ""
	// CurrentVersion current project version
	CurrentVersion = "1.5.0"
	// BuildDate compile date
	BuildDate = ""
	// GoVersion system go version
	GoVersion = runtime.Version()
	// Platform info
	Platform = fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH)
)

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
cmd
internal
adapt/mock_adapt
Package mock_adapt is a generated GoMock package.
Package mock_adapt is a generated GoMock package.
app
checker/mock_checker
Package mock_checker is a generated GoMock package.
Package mock_checker is a generated GoMock package.
peermgr/mock_peermgr
Package mock_peermgr is a generated GoMock package.
Package mock_peermgr is a generated GoMock package.
router/mock_router
Package mock_router is a generated GoMock package.
Package mock_router is a generated GoMock package.
txcrypto/mock_txcrypto
Package mock_txcrypto is a generated GoMock package.
Package mock_txcrypto is a generated GoMock package.
pkg
plugins/mock_client
Package mock_client is a generated GoMock package.
Package mock_client is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL