Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wormholes-org/wormholes

a project of public blockchain, support rich functionality for NFT
https://github.com/wormholes-org/wormholes

Last synced: about 1 month ago
JSON representation

a project of public blockchain, support rich functionality for NFT

Awesome Lists containing this project

README 

        
# WormholesChain



The WormholesChain solves the blockchain trilemma, which entails a necessary tradeoff between scalability, security, and decentralization, by building the

technology to achieve the ideal balance between these three metrics, creating a highly scalable and secure blockchain system that doesn’t sacrifice

decentralization.



[![Gitter](https://badges.gitter.im/wormholes-org/Internal-test-miner.svg)](https://gitter.im/wormholes-org/Internal-test-miner?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)



## The Approach



The significant step before spinning up your node is choosing your approach. Based on requirements and many potential possibilities,

you must select the client implementation (of both execution and consensus clients), the environment (hardware, system), and the

parameters for client settings.



To decide whether to run the software on your hardware or in the cloud depending on your demands.



You can use the startup script to start your node after preparing the environment.



When the node is running and syncing, you are ready to use it, but make sure to keep an eye on its maintenance.



## Environment and Hardware



Wormholes clients are able to run on consumer-grade computers and do not require any special hardware, such as mining machines.

Therefore, you have more options for deploying the node based on your demands. let us think about running a node on both a local

physical machine and a cloud server:



### Hardware



Wormholes clients can run on your computer, laptop, server, or even a single-board computer. Although running clients on

different devices are possible, it had better use a dedicated machine to enhance its performance and underpin the security,

which can minimize the impact on your computer.



Hardware requirements differ by the client but generally are not that high since the node just needs to stay synced.



Do not confuse it with mining, which requires much more computing power. However , sync time and performance do improve with more

powerful hardware.



### Minimum requirements



-  CPU: Main frequency 2.9GHz, 4 cores or above CPU.

-  Memory: Capacity 8GB or more.

-  Hard Disk: Capacity 500GB or more.

-  Network bandwidth: 6M uplink and downlink peer-to-peer rate or higher



Before installing the client, please ensure your computer has enough resources to run it. You can find the minimum and recommended requirements below.



## Spin-up Your Own Wormholes Node



Participate in the Wormholes blockchain public testnet, jointly support and maintain the Wormholes network ecosystem, and you can obtain corresponding

benefits. 



This tutorial will guide you to deploy Wormholes nodes and participate in verifying the security and reliability of the Wormholes network. Choose the 

software tools and deployment methods you are familiar with to maintain your own nodes.



### Docker Clients Setup



#### Preparation



- Install wget. 



  Please go to the [wget website](https://www.gnu.org/software/wget/) to download and install it. If you are using Linux system, you can also 

install it using the `apt-get install wget` command. If you are using MacOS system, you can also install it using the `brew install wget` command.



- Install Docker.



  For the installation and use of Docker, please refer to the [Docker Official Documentation](https://docs.docker.com/engine/install/).



#### Run the node



When using the script to start the node, you must enter the private key of the account used for pledge prepared earlier. For details, see the

documentation [Deploy Wormholes Nodes Using Official Scripts](https://www.wormholes.com/docs/install/run/docker/docker_3/index.html).



### Manual clients setup



The actual client setup can be done by using the automatic launcher or manually.



For ordinary users, we recommend you use a startup script, which guides you through the installation and automates the client setup process. However, if

you have experience with the terminal, the manual setup steps should be easy to follow.



#### Startup parameters



- Start ***Wormholes*** in fast sync mode (default, can be changed withthe ***--syncmode*** flag),causing it to download more data in exchange for

avoiding processing the entire history of the Wormholes Chain network, which is very CPU intensive.



- Start up***Wormholes's*** built-in interactive JavaScript,(via the trailing ***console*** subcommand) through which you can interact using ***web3***

  [methods](https://web3js.readthedocs.io/en/v1.2.9/)(note: the ***web3*** version bundled within ***Wormholes*** is very old, and

  not up to date with official docs), as well as ***Wormholes's*** own [management APIs](https://www.wormholes.com/docs/management/) .

  This tool is optional and if you leave it out you can always attach to an already running ``Wormholes`` instance with ***Wormholes attach*** .



#### Full nodes functions



-  Stores the full blockchain history on disk and can answer the data request from the network.

-  Receives and validates the new blocks and transactions.

-  Verifies the states of every account.



#### Start ordinary node



1. Download the binary, config and genesis files from [release](https://github.com/wormholes-org/wormholes), or compile the binary by ``make wormholes``.



2. Start your full node.



   ````

      # Ordinary nodes need to be started in full mode

      ./wormholes --devnet --syncmode=full



   ````



#### Start validator node



1. Download the binary, config and genesis files from [release](https://github.com/wormholes-org/wormholes), or compile the binary by ``make wormholes``.



2. Prepare a script to start the node, and name it run_node (If the system is windows, you need to add the file suffix .bat), or something else. Note that

the script should be in the same directory as the main Wormholes program.



   If you are using the windows system, the reference is as follows:



   ````

	@echo off

	set rootPath=%~dp0

	set nodePath=%rootPath%.wormholes

	if exist %nodePath% (

	     rd /s/q %nodePath%

	)



	if "%1" == "" (

	   echo "Please pass in the private key of the account to be pledged."

		exit -1

	) else (

	   md %nodePath%\geth

	   echo %1 > %nodePath%\geth\nodekey

	   wormholes.exe --devnet --datadir %nodePath% --mine --syncmode=full

	)

   

   ````



   If you are using a Linux system, the reference is as follows:



   ````

      

	#!/bin/bash

	# write private key to file

	if [ -d .wormholes ]; then

	   rm -rf .wormholes

	fi



	if [[ $# -gt 0 ]] ; then

	   mkdir -p .wormholes/wormholes

	   echo $1>.wormholes/wormholes/nodekey

	else

	   echo "Please pass in the private key of the account to be pledged."

	   return -1

	fi

	./wormholes --devnet --datadir .wormholes --syncmode=full

   

   ````



3. Start node.



   You can start a node based on the startup parameters, or you can start your own node using a startup script. If you use scripts, you need to select

   scripts for different environments according to different system environments. When running the startup script, you must pass in the private key of the

   account to be pledged, which is the private key saved in step 1.  the reference is as follows:



   ````



	#linux system

	#Runtime parameter -- private

	./run_node 94b796b1b11893561c34cf000f23ecf3b39067bb198b9ec9f7b1a79646114680



	#windows system

	#Go to the directory where the startup script is located in the CMD terminal

	./run_node.bat 94b796b1b11893561c34cf000f23ecf3b39067bb198b9ec9f7b1a79646114680



   ````