1 unstable release

Uses old Rust 2015

0.1.0 Feb 28, 2021

#1338 in Magic Beans

39 downloads per month
Used in 29 crates (5 directly)

GPL-3.0 license

5KB
66 lines

Tetsy Vapory

The Fastest and most Advanced Vapory Client.

» Download the latest release «

Table of Contents

  1. Description
  2. Technical Overview
  3. Building
    3.1 Building Dependencies
    3.2 Building from Source Code
    3.3 Simple One-Line Installer for Mac and Linux
    3.4 Starting Tetsy Vapory
  4. Testing
  5. Documentation
  6. Toolchain
  7. Community
  8. Contributing
  9. License

1. Description

Built for mission-critical use: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. Tetsy Vapory provides the core infrastructure essential for speedy and reliable services.

  • Clean, modular codebase for easy customisation
  • Advanced CLI-based client
  • Minimal memory and storage footprint
  • Synchronise in hours, not days with Warp Sync
  • Modular for light integration into your service or product

2. Technical Overview

Tetsy Vapory's goal is to be the fastest, lightest, and most secure Vapory client. We are developing Tetsy Vapory using the sophisticated and cutting-edge Rust programming language. Tetsy Vapory is licensed under the GPLv3 and can be used for all your Vapory needs.

By default, Tetsy Vapory runs a JSON-RPC HTTP server on port :8545 and a Web-Sockets server on port :8546. This is fully configurable and supports a number of APIs.

If you run into problems while using Tetsy Vapory, check out the wiki for documentation, feel free to file an issue in this repository, or hop on our Gitter or Riot chat room to ask a question. We are glad to help! For security-critical issues, please refer to the security policy outlined in SECURITY.md.

Tetsy Vapory's current beta-release is 2.6. You can download it at the releases page or follow the instructions below to build from source. Please, mind the CHANGELOG.md for a list of all changes between different versions.

3. Building

3.1 Build Dependencies

Tetsy Vapory requires latest stable Rust version to build.

We recommend installing Rust through rustup. If you don't already have rustup, you can install it like this:

  • Linux:

    $ curl https://sh.rustup.rs -sSf | sh
    

    Tetsy Vapory also requires gcc, g++, pkg-config, file, make, and cmake packages to be installed.

  • OSX:

    $ curl https://sh.rustup.rs -sSf | sh
    

    clang is required. It comes with Xcode command line tools or can be installed with homebrew.

  • Windows: Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the rustup installer from https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe, start "VS2015 x64 Native Tools Command Prompt", and use the following command to install and set up the msvc toolchain:

    $ rustup default stable-x86_64-pc-windows-msvc
    

Once you have rustup installed, then you need to install:

Make sure that these binaries are in your PATH. After that, you should be able to build Tetsy Vapory from source.

3.2 Build from Source Code

# download Tetsy Vapory code
$ git clone https://github.com/openvapory/tetsy-vapory
$ cd tetsy-vapory

# build in release mode
$ cargo build --release --features final

This produces an executable in the ./target/release subdirectory.

Note: if cargo fails to parse manifest try:

$ ~/.cargo/bin/cargo build --release

Note, when compiling a crate and you receive errors, it's in most cases your outdated version of Rust, or some of your crates have to be recompiled. Cleaning the repository will most likely solve the issue if you are on the latest stable version of Rust, try:

$ cargo clean

This always compiles the latest nightly builds. If you want to build stable or beta, do a

$ git checkout stable

or

$ git checkout beta

3.3 Simple One-Line Installer for Mac and Linux

bash <(curl https://get.tetcoin.org -L)

The one-line installer always defaults to the latest beta release. To install a stable release, run:

bash <(curl https://get.tetcoin.org -L) -r stable

3.4 Starting Tetsy Vapory

Manually

To start Tetsy Vapory manually, just run

$ ./target/release/tetsy

so Tetsy Vapory begins syncing the Vapory blockchain.

Using systemd service file

To start Tetsy Vapory as a regular user using systemd init:

  1. Copy ./scripts/tetsy.service to your systemd user directory (usually ~/.config/systemd/user).
  2. Copy release to bin folder, write sudo install ./target/release/tetsy /usr/bin/tetsy
  3. To configure Tetsy Vapory, write a /etc/tetsy/config.toml config file, see Configuring Tetsy Vapory for details.

4. Testing

Download the required test files: git submodule update --init --recursive. You can run tests with the following commands:

  • All packages

    cargo test --all
    
  • Specific package

    cargo test --package <spec>
    

Replace <spec> with one of the packages from the package list (e.g. cargo test --package vvmbin).

You can show your logs in the test output by passing --nocapture (i.e. cargo test --package vvmbin -- --nocapture)

5. Documentation

Official website: https://tetcoin.org

Be sure to check out our wiki for more information.

Viewing documentation for Tetsy Vapory packages

You can generate documentation for Tetsy Vapory Rust packages that automatically opens in your web browser using rustdoc with Cargo (of the The Rustdoc Book), by running the the following commands:

  • All packages

    cargo doc --document-private-items --open
    
  • Specific package

    cargo doc --package <spec> -- --document-private-items --open
    

Use--document-private-items to also view private documentation and --no-deps to exclude building documentation for dependencies.

Replacing <spec> with one of the following from the details section below (i.e. cargo doc --package tetsy-vapory --open):

Package List

  • Tetsy Vapory (VapCore) Client Application
    tetsy-vapory
    
  • Tetsy Vapory Account Management, Key Management Tool, and Keys Generator
    vapcore-accounts, vapkey-cli, vapstore, vapstore-cli
    
  • Parity Chain Specification
    chainspec
    
  • Parity CLI Signer Tool & RPC Client
    cli-signer rpc-client
    
  • Tetsy Vapory Vapash & ProgPoW Implementations
    vapash
    
  • Parity (VapCore) Library
    vapcore
    
    • Tetsy Vapory Blockchain Database, Test Generator, Configuration, Caching, Importing Blocks, and Block Information
      vapcore-blockchain
      
    • Tetsy Vapory (VapCore) Contract Calls and Blockchain Service & Registry Information
      vapcore-call-contract
      
    • Tetsy Vapory (VapCore) Database Access & Utilities, Database Cache Manager
      vapcore-db
      
    • Tetsy Vapory Virtual Machine (VVM) Rust Implementation
      vvm
      
    • Tetsy Vapory (VapCore) Light Client Implementation
      vapcore-light
      
    • Parity Smart Contract based Node Filter, Manage Permissions of Network Connections
      node-filter
      
    • Parity Private Transactions
      private
      
    • Tetsy Vapory (VapCore) Client & Network Service Creation & Registration with the I/O Subsystem
      vapcore-service
      
    • Tetsy Vapory (VapCore) Blockchain Synchronization
      vapcore-sync
      
    • Tetsy Vapory Common Types
      common-types
      
    • Tetsy Vapory Virtual Machines (VM) Support Library
      vm
      
    • Tetsy Vapory WASM Interpreter
      wasm
      
    • Vapcore WASM Test Runner
      vapcore-wasm-run-test
      
    • Parity VVM Implementation
      vvmbin
      
    • Tetsy Vapory IPFS-compatible API
      tetsy-ipfs-api
      
    • Tetsy Vapory JSON Deserialization
      vapjson
      
    • Tetsy Vapory State Machine Generalization for Consensus Engines
      tetsy-machine
      
  • Tetsy Vapory (VapCore) Miner Interface
    vapcore-miner tetsy-local-store price-info vapcore-stratum using_queue
    
  • Tetsy Vapory (VapCore) Logger Implementation
    vapcore-logger
    
  • C bindings library for the Tetsy Vapory client
    tetsy-clib
    
  • Tetsy Vapory JSON-RPC Servers
    tetsy-rpc
    
  • Tetsy Vapory (VapCore) Secret Store
    vapcore-secretstore
    
  • Parity Updater Service
    tetsy-updater tetsy-hash-fetch
    
  • Parity Core Libraries (Parity Util)
    vapcore-bloom-journal blooms-db dir vip-712 fake-fetch fastmap fetch vapcore-io
    journaldb tetsy-keccak-hasher len-caching-lock macros memory-cache memzero
    migration-rocksdb vapcore-network vapcore-network-devp2p panic_hook
    patricia-trie-vapory tetsy-registrar rlp_compress tetsy-rlp-derive tetsy-runtime stats
    time-utils triehash-vapory unexpected tetsy-version
    

Contributing to documentation for Tetsy Vapory packages

Document source code for Tetsy Vapory packages by annotating the source code with documentation comments.

Example (generic documentation comment):

/// Summary
///
/// Description
///
/// # Panics
///
/// # Errors
///
/// # Safety
///
/// # Examples
///
/// Summary of Example 1
///
/// ```rust
/// // insert example 1 code here for use with documentation as tests
/// ```
///

6. Toolchain

In addition to the Tetsy Vapory client, there are additional tools in this repository available:

  • vvmbin - Tetsy Vapory VVM Implementation.
  • vapstore - Tetsy Vapory Key Management.
  • vapkey - Tetsy Vapory Keys Generator.

The following tool is available in a separate repository:

  • vapabi - Tetsy Vapory Encoding of Function Calls. Docs here
  • whisper - Tetsy Vapory Whisper-v2 PoC Implementation.

7. Community

Join the chat!

Questions? Get in touch with us on Twitter: Twitter

8. Contributing

An introduction has been provided in the "So You Want to be a Core Developer" presentation slides by Hernando Castano. Additional guidelines are provided in CONTRIBUTING.

Contributor Code of Conduct

CODE_OF_CONDUCT

9. License

LICENSE

Dependencies

~1.1–1.6MB
~33K SLoC

;`