Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 6.21 KB

README.md

File metadata and controls

82 lines (53 loc) · 6.21 KB
Raw

EOSIO Labs™: EOSIO Toppings

EOSIO Labs badge PRs welcome badge

This is a monorepo composed of the various packages which work together to create a web-based development tool to help users create applications on the EOSIO blockchain. Users will be able to perform various actions related to smart contract and application development using this tool.

Overview

EOSIO Labs™: EOSIO Toppings is a monorepo which consists of the various services and tools needed for the EOSIO Labs™: EOSIO Explorer to run properly. In order to decouple the tool from the reusable parts of the system, the monorepo was created. This also allows the possibility of development work to take place on many parts of the tool system concurrently and makes it easier for users interested in contributing to find out how the entire toolchain works.

The monorepo contains two categories of packages:

  1. ⚡ API Services - Services which directly interface with the EOSIO Blockchain, either with the RPC API or through a data store
  2. 💻 Docker-based Services - Responsible for Docker containers which independently run instances of services which the EOSIO Explorer interfaces with

About EOSIO Labs

EOSIO Labs repositories are experimental. Developers in the community are encouraged to use EOSIO Labs repositories as the basis for code and concepts to incorporate into their applications. Community members are also welcome to contribute and further develop these repositories. Since these repositories are not supported by Block.one, we may not provide responses to issue reports, pull requests, updates to functionality, or other requests from the community, and we encourage the community to take responsibility for these.

Package Index

  • API Services:

    • EOSIO Compiler / Deployment Service npm npm:

      • Node.JS/Express API server for compiling and deploying smart contracts to a nodeos instance. Spins up a Docker container under the hood for contract compilation.

    • MongoDB Plugin API npm npm:

      • TypeScript API service for interacting with the blockchain MongoDB (nodeos run with the MongoDB plugin)

    • RPC API npm npm:

      • TypeScript API service wrapper around the EOSIO RPC API

  • Docker-based Services:

Platform Support

  • Amazon Linux 2
  • CentOS 7
  • Ubuntu 16.04
  • Ubuntu 18.04
  • MacOS 10.14 (Mojave)

Required Tools

  • Yarn with support at ^1.15.2 (latest stable)
  • Docker with support at Docker Engine 18.09.2 (latest stable)
  • Node.JS with support at ^10.15.3 LTS (latest stable)

Installation

git clone https://github.com/EOSIO/eosio-toppings.git
yarn install

Default Ports

The following ports need to be opened in your local machine by default:

  • 3000 [ UI - Create react app dev service ( only used for development of this tools)]
  • 5111 [ UI - Frontend app service ]
  • 8081 [ EOSIO compiler/deployment service ]
  • 8888 [ Nodeos RPC Api service ] ( not configurable in config file )
  • 27788 [ MongoDB Api service ]

License

MIT

Important

See LICENSE for copyright and license terms. Block.one makes its contribution on a voluntary basis as a member of the EOSIO community and is not responsible for ensuring the overall performance of the software or any related applications. We make no representation, warranty, guarantee or undertaking in respect of the software or any related documentation, whether expressed or implied, including but not limited to the warranties or merchantability, fitness for a particular purpose and noninfringement. In no event shall we be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or documentation or the use or other dealings in the software or documentation. Any test results or performance figures are indicative and will not reflect performance under all conditions. Any reference to any third party or third-party product, service or other resource is not an endorsement or recommendation by Block.one. We are not responsible, and disclaim any and all responsibility and liability, for your use of or reliance on any of these resources. Third-party resources may be updated, changed or terminated at any time, so the information here may be out of date or inaccurate.

Wallets and related components are complex software that require the highest levels of security. If incorrectly built or used, they may compromise users’ private keys and digital assets. Wallet applications and related components should undergo thorough security evaluations before being used. Only experienced developers should work with this software.