poly

command module
v1.8.3 Latest Latest
Warning

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

Go to latest
Published: Jan 28, 2022 License: LGPL-3.0 Imports: 43 Imported by: 0

README

Poly

Version 1.0

Discord

English | 中文

Welcome to the official Go implementation of the Poly Network !

Poly is a blockchain system providing cross-chain interactive services. Your transaction on chain X can be relayed to other chain Y and executed, we call this kind of transaction as cross-chain transaction. Any chain which implement Poly cross-chain interactive protocol can join the poly ecosystem. For now, we have Ethereum, Ontology, Switcheo, Neo, Bitcoin and BSC. You can transfer asset from one chain to another. Like ETH, BTC, ONT, ONG, ERC20, OEP4, NEO, BSC etc, and any message between different chains.

Features

  • Highly optimized transaction processing speed
  • Multiple encryption algorithms supported
  • Quick block generation time 1s
  • Support for heterogeneous and homogeneous chains
  • Supports cross chain transaction consistency and finality
  • Supports variety of heterogeneous chain protocol (Bitcoin/Ethereum/Neo/Ontology/Cosmos-SDK/BSC)

Install from Binaries

Downloading a specific version from the release section.

Build From Source

Prerequisites

  • Golang version 1.15 or later

Build

Note that the code in the master branch may not be stable.

git clone https://github.com/polynetwork/poly.git
cd poly
make all

After building the source code successfully, you should see the executable program poly.

Build Docker Image

You can build a poly docker image pre-installed the ploy executable program.

make dockerImg

You would find the image polynetwork/poly and you can run a container from it.

Run Poly

The Poly CLI can run nodes for the MainNet, TestNet and local PrivateNet.

Before you can run the node you will need to create a wallet file. A wallet file named wallet.dat can be generated by running

./poly account add -d

Here's an example of the directory structure

$ tree
└── poly
    ├── poly
    └── wallet.dat

MainNet Sync Node

Before you start node, you need to register your account to be a relayer to get permission to send transactions to Poly.

You can run an Poly MainNet node built from the source code with:

./poly

TestNet Sync Node

Before you start node, you need to register your account to be a relayer to get permission to send transactions to Poly.

You can run an Poly TestNet node built from the source code with:

./poly --networkid 2

Local PrivateNet

The Poly CLI allows you to run a local PrivateNet on your computer. To start the PrivateNet built from the source code with:

./poly --testmode  

Contributions

Contributors to Poly are very welcome! Before beginning, please take a look at our contributing guidelines. You can open an issue by clicking here.

If you have any issues getting setup, open an issue or reach out in the Poly Network Discord.

License

The Poly source code is available under the LGPL-3.0 license.

Documentation

Overview

* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library. * * The poly network is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * The poly network is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with the poly network. If not, see <http://www.gnu.org/licenses/>.

Directories

Path Synopsis
cmd
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
abi
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
sigsvr
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
sigsvr/handlers
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
sigsvr/store
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
log
core
store/ledgerstore
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
store/overlaydb
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
http
base/actor
Package actor privides communication with other actor
Package actor privides communication with other actor
base/common
Package common privides functions for http handler call * Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
Package common privides functions for http handler call * Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
base/error
Package error privides error code for http
Package error privides error code for http
base/rest
Package rest privides functions to for restful server call
Package rest privides functions to for restful server call
base/rpc
Package rpc privides functions to for rpc server call
Package rpc privides functions to for rpc server call
jsonrpc
Package jsonrpc privides a function to start json rpc server
Package jsonrpc privides a function to start json rpc server
localrpc
Package localrpc privides a function to start local rpc server
Package localrpc privides a function to start local rpc server
nodeinfo
Package nodeinfo privides functions for nodeinfo server
Package nodeinfo privides functions for nodeinfo server
restful
Package restful privides a function to start restful server
Package restful privides a function to start restful server
restful/restful
Package restful privides restful server router and handler
Package restful privides restful server router and handler
websocket
Package websocket privides a function to start websocket server
Package websocket privides a function to start websocket server
websocket/session
Package session privides websocket server manager sessionlist
Package session privides websocket server manager sessionlist
websocket/websocket
Package websocket privides websocket server handler
Package websocket privides websocket server handler
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/bsc
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/btc
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/common
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/cosmos
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/eth
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/msc
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/neo
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/neo3
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/okex
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/polygon
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/cross_chain_manager/quorum
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/governance/side_chain_manager
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/bsc
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/eth
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/eth/rlp
Package rlp implements the RLP serialization format.
Package rlp implements the RLP serialization format.
service/header_sync/heco
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/msc
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/okex
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/okex/ethsecp256k1
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/polygon
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/polygon/types
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/polygon/types/common
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/polygon/types/secp256k1
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
service/header_sync/quorum
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
common
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
* Copyright (C) 2021 The poly network Authors * This file is part of The poly network library.
net/protocol
Package p2p provides an network interface
Package p2p provides an network interface
Package txnpool provides a function to start micro service txPool for external process
Package txnpool provides a function to start micro service txPool for external process
common
Package common provides constants, common types for other packages
Package common provides constants, common types for other packages
proc
Package proc provides functions for handle messages from consensus/ledger/net/http/validators
Package proc provides functions for handle messages from consensus/ledger/net/http/validators
validator
db

Jump to

Keyboard shortcuts

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