eos README

The project's README from github.com/EOSIO/eos. As one markdown file: README.md.

EOSIO - The Most Powerful Infrastructure for Decentralized Applications

Build status

Welcome to the EOSIO source code repository! This software enables businesses to rapidly build and deploy high-performance and high-security blockchain-based applications.

Some of the groundbreaking features of EOSIO include:

  1. Free Rate Limited Transactions
  2. Low Latency Block confirmation (0.5 seconds)
  3. Low-overhead Byzantine Fault Tolerant Finality
  4. Designed for optional high-overhead, low-latency BFT finality
  5. Smart contract platform powered by WebAssembly
  6. Designed for Sparse Header Light Client Validation
  7. Scheduled Recurring Transactions
  8. Time Delay Security
  9. Hierarchical Role Based Permissions
  10. Support for Biometric Hardware Secured Keys (e.g. Apple Secure Enclave)
  11. Designed for Parallel Execution of Context Free Validation Logic
  12. Designed for Inter Blockchain Communication

Disclaimer

Block.one is neither launching nor operating any initial public blockchains based upon the EOSIO software. This release refers only to version 1.0 of our open source software. We caution those who wish to use blockchains built on EOSIO to carefully vet the companies and organizations launching blockchains based on EOSIO before disclosing any private keys to their derivative software.

Official Testnet

testnet.eos.io

Supported Operating Systems

EOSIO currently supports the following operating systems:

  1. Amazon Linux 2
  2. CentOS 7
  3. CentOS 7.x
  4. CentOS 8
  5. Ubuntu 16.04
  6. Ubuntu 18.04
  7. Ubuntu 20.04
  8. MacOS 10.14 (Mojave)
  9. MacOS 10.15 (Catalina)

Note: It may be possible to install EOSIO on other Unix-based operating systems. This is not officially supported, though.

Software Installation

If you are new to EOSIO, it is recommended that you install the EOSIO Prebuilt Binaries, then proceed to the Getting Started Guide. If you are an advanced developer, a block producer, or no binaries are available for your platform, you may need to Build EOSIO from source.

Note: If you used our scripts to build/install EOSIO, please run the Uninstall Script before using our prebuilt binary packages.

Prebuilt Binaries

Prebuilt EOSIO software packages are available for the operating systems below. Find and follow the instructions for your OS:

Mac OS X:

Mac OS X Brew Install

brew tap eosio/eosio
brew install eosio

Note: On MacOS 10.15 (Catalina), there is a chance to face the linking error below which prevents successful installation of EOSIO:

Reinstalling 1 broken dependent from source:
eosio/eosio/eosio

The following Homebrew commands will resolve this issue:

brew link eosio

Mac OS X Brew Uninstall

brew remove eosio

Ubuntu Linux:

Ubuntu 20.04 Package Install

wget https://github.com/eosio/eos/releases/download/v2.1.0/eosio_2.1.0-1-ubuntu-20.04_amd64.deb
sudo apt install ./eosio_2.1.0-1-ubuntu-20.04_amd64.deb

Ubuntu 18.04 Package Install

wget https://github.com/eosio/eos/releases/download/v2.1.0/eosio_2.1.0-1-ubuntu-18.04_amd64.deb
sudo apt install ./eosio_2.1.0-1-ubuntu-18.04_amd64.deb

Ubuntu 16.04 Package Install

wget https://github.com/eosio/eos/releases/download/v2.1.0/eosio_2.1.0-1-ubuntu-16.04_amd64.deb
sudo apt install ./eosio_2.1.0-1-ubuntu-16.04_amd64.deb

Ubuntu Package Uninstall

sudo apt remove eosio

RPM-based (CentOS, Amazon Linux, etc.):

RPM Package Install CentOS 7

wget https://github.com/eosio/eos/releases/download/v2.1.0/eosio-2.1.0-1.el7.x86_64.rpm
sudo yum install ./eosio-2.1.0-1.el7.x86_64.rpm

RPM Package Install CentOS 8

wget https://github.com/eosio/eos/releases/download/v2.1.0/eosio-2.1.0-1.el8.x86_64.rpm
sudo yum install ./eosio-2.1.0-1.el8.x86_64.rpm

RPM Package Uninstall

sudo yum remove eosio

Uninstall Script

To uninstall the EOSIO built/installed binaries and dependencies, run:

./scripts/eosio_uninstall.sh

Documentation

  1. Nodeos
  2. Cleos
  3. Keosd

Resources

  1. Website
  2. Blog
  3. Developer Portal
  4. StackExchange for Q&A
  5. Community Telegram Group
  6. Developer Telegram Group
  7. White Paper
  8. Roadmap

Getting Started

Instructions detailing the process of getting the software, building it, running a simple test network that produces blocks, account creation and uploading a sample contract to the blockchain can be found in the Getting Started Guide.

Contributing

Contributing Guide

Code of Conduct

License

EOSIO is released under the open source MIT license and is offered “AS IS” without warranty of any kind, express or implied. Any security provided by the EOSIO software depends in part on how it is used, configured, and deployed. EOSIO is built upon many third-party libraries such as WABT (Apache License) and WAVM (BSD 3-clause) which are also provided “AS IS” without warranty of any kind. Without limiting the generality of the foregoing, Block.one makes no representation or guarantee that EOSIO or any third-party libraries will perform as intended or will be free of errors, bugs or faulty code. Both may fail in large or small ways that could completely or partially limit functionality or compromise computer systems. If you use or implement EOSIO, you do so at your own risk. In no event will Block.one be liable to any party for any damages whatsoever, even if it had been advised of the possibility of damage.

Important

See LICENSE for copyright and license terms.

All repositories and other materials are provided subject to the terms of this IMPORTANT notice and you must familiarize yourself with its terms. The notice contains important information, limitations and restrictions relating to our software, publications, trademarks, third-party resources, and forward-looking statements. By accessing any of our repositories and other materials, you accept and agree to the terms of the notice.

eos (EOSIO/eos)

Searching Database…

11.2K ·GitHub
Eos
archived
What is this?EOSIO is an open source smart contract platform: blockchain software that lets businesses build and deploy high-performance, high-security decentralized applications.
Is this something I host and run myself, or an online service?You run it yourself as node software. The package includes nodeos (the blockchain node), keosd (key and wallet manager) and cleos, the command-line interface to both.
How do I get it running?Install the prebuilt binaries — Homebrew on macOS, .deb packages on Ubuntu, RPM on CentOS or Amazon Linux — then follow the Getting Started Guide. Advanced users can build from source.
Is EOSIO still being developed?No — the repository is archived, so this code gets no further updates. Also, Block.one launched no public blockchains on it: the README warns you to vet whoever runs a chain before trusting it with your keys.
Which operating systems does it support?Officially Amazon Linux 2, CentOS 7 and 8, Ubuntu 16.04, 18.04 and 20.04, and macOS 10.14-10.15. Other Unix-based systems may work but are unsupported; Windows is not supported.
What does the license allow?MIT — free to use, modify and redistribute. But it is offered 'AS IS' without any warranty, and Block.one disclaims liability even for failures that compromise computer systems.
How fast is it compared to other blockchains?Blocks confirm in 0.5 seconds with low-overhead Byzantine Fault Tolerant finality, and the design targets parallel execution of validation logic — unusually high numbers for a blockchain.
Can I try it without risking anything?Yes. There is an official testnet at testnet.eos.io, and the Getting Started Guide walks through a simple local test network that produces blocks, creates accounts and deploys a sample contract.
What features stand out beyond raw speed?Free rate-limited transactions, scheduled recurring transactions, time-delay security, hierarchical role-based permissions, biometric hardware-secured keys such as Apple Secure Enclave, and built-in inter-blockchain communication.
How do smart contracts run on it?The platform is powered by WebAssembly: contracts execute as Wasm, and the build relies on third-party WebAssembly tooling, WABT and WAVM.
What are similar projects?SolcQueue, shardeum, go-ethereum, linera-protocol, fuel-core, WasmEdge, SolidityCoreLegend, diem
Which topics is it in?smart-contracts, decentralized, web3, blockchain, wasm, distributed-systems, cpp, c++, performance, api, server, self-hosted
Creator
EOSIO
Size
303 MB
Stars
11.2K
Updated
CommitJul 19Releasev2.0.13Aug 24
Age
9y
Commits · 90 Days