swaptoshi-core
v1.0.0-alpha.2
Published
Decentralized Exchange (DEX) Protocol built using Klayr SDK
Downloads
8
Maintainers
Readme
Swaptoshi Core
Swaptoshi is a Fair-Launched, Community-Driven, Klayr DEX.
Swaptoshi Core is the program that implements the Swaptoshi Protocol. In other words, Swaptoshi Core is what every machine needs to set-up to run a node that allows for participation in the Swaptoshi network.
Swaptoshi Core was bootstrapped with Klayr SDK v6. You can learn more in Klayr's official documentation.
Installation
Dependencies
The following dependencies need to be installed in order to run Swaptoshi Core, which created with the Klayr SDK:
| Dependencies | Version | | ------------------------ | ------- | | NodeJS | 18.16 | | Python (for development) | 2.7.18 |
You can find further details on installing these dependencies in Klayr SDK pre-installation setup guide.
Clone the Swaptoshi Core repository using Git and initialize the modules.
NPM
npm install -g swaptoshi-core
From Source
git clone https://github.com/swaptoshi/swaptoshi-core.git
cd swaptoshi-core
npm install
npm run build
./bin/run --help
Optionally Setup the swaptoshi-core alias, by running this command:
echo "alias swaptoshi-core=$(pwd)/bin/run" >> ~/.profile && source ~/.profile
After that, you could use swaptoshi-core
command instead of ./bin/run
:
swaptoshi-core --help
Managing Swaptoshi Node
System requirements
The following system requirements are recommended for validator nodes:
Memory
- Machines with a minimum of 8 GB RAM for the Mainnet.
- Machines with a minimum of 8 GB RAM for the Testnet.
Storage
- Machines with a minimum of 40 GB HDD.
OS
- Ubuntu 22
- Ubuntu 20
- MacOS 13
License
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.