All Collections
EOS Support Media
Ready for the New EOS? Introducing API+ of the ENF Blue Papers
Ready for the New EOS? Introducing API+ of the ENF Blue Papers

Published on November 4, 2022

Markus Hinrichs avatar
Written by Markus Hinrichs
Updated over a week ago

Author: Markus Hinrichs

Editor: Randall Roland

On behalf of the EOS Network Foundation four initial Blue Papers have been elaborated in 2021 by cutting edge blockchain experts in order to catapult EOS into the future making it the best-in-class smart contract development platform for Web3 applications.

EOS, the world's largest DAO, has just celebrated its Independence Day and is now a community-driven blockchain running on the lightning-fast AntelopeIO.

Note: This is the fourth article of the series "Ready for the New EOS" of the EOS Support Media Collection, where we condence the ENF blue papers for our readers.

API+ Providing access for the next generation of Apps

The teams of EOS Nation, EOS Rio and Greymass worked together for this task based on their experience in developing, operating and using EOSIO (now AntelopeIO) APIs.

In 2021, ENF brought together three high-level teams to discuss the API (application programming interface) situation, identify problems and propose solutions to make app access to EOSIO (now AntelopeIO) data easier and smoother using state-of-the-art APIs.

Introduction

The development of this so-called Blue Paper, as well as the other three Blue Papers (Core+, Wallet+ and Audit+), was funded by the ENF with $250,000 each. The requirements for this paper, which was to be a mixture of white paper, yellow paper, request for proposals and roadmap, were therefore extremely high. The working group, including the Greymass team (developers of the Anchor Wallet), EOS Rio and EOS Nation, was given a window of time until early 2022.

The ENF relied on this working group constellation because all of the three independent teams had significant experience in software development, infrastructure operations, and experience delivering history solutions within EOSIO and the larger blockchain ecosystem. The original paper was to be called History+, but this name was changed to API+ after intensive initial discussions within the working group, as this broadened the necessary focus of the group to essentials and thus better described it.

Gathering Information

Many different approaches to "data collection" were used, including:

  • Soliciting stakeholder input

    • Dozens of organizations provided valuable feedback with their wants and needs

  • EOSIO discussion channels were scoured to understand how developers use EOSIO APIs and where things sometimes get stuck

Writing process

Smaller working groups worked on the multitude of topics that emerged from the information gathering, resulting in a variety of specific documents. Then, in the large group, it was important to find the overlaps, take them out, and create a consistent document with all the relevant points that were used as proposed solutions in the last part of the paper and those that were not to be submitted as proposals.

Fundamental principles underlying this paper

These are the most impacted by changes to APIs, the major groups for whom APIs should be developed:

- Application developers

- Data analysts

- Exchanges/custodial services

- Executives/leadership roles

- Operators and service providers

- Protocol/tooling developers

- Smart contract developers

Further defined principles

  • Developers first

    • Make the use of APIs as easy as possible for developers and new entrants

  • Future oriented

    • Evaluate and improve the current situation with an eye to the future

  • Encourage decentralization

  • Work pragmatically

    • Aim for the best possible goal in view of finite resources available for development

  • Deliberate development

  • Accessibility

    • Access to APIs should be easy, in different programming languages and working environments, and based on documented standards

  • Interoperable

    • All proposed solutions should integrate with other systems in EOSIO but also outside.

After discussing which APIs already exist in EOSIO, a distinction was made between native EOSIO APIs, Communty-developed APIs and non-EOSIO-specific APIs. The last and most comprehensive part of the API+ Blue Paper deals with the proposals for the ENF.

API+ Working Group Proposals

During the process of writing this Blue Paper, dozens of blockchain experts were interviewed to understand their needs and desires. Some problems were based on sheer unknowing, which could be addressed with educational initiatives (e.g. Learning Center). Others require very complex solutions. A total of 8 proposals were made, the first of which is one of the most important, namely to establish a permanent working group (APR) to coordinate the implementation of the proposals made.

1. API Research and Standards

The APR team performs an important research and coordination role to support the extremely complex development of EOSIO APIs.


2. Transaction Lifecycles


At the core API level, an enhancement for transaction flow is to be introduced. This enhancement needs to be done by a team of experts and should be overseen by the API+ working group, as no APR team has been formed yet.




3. Specialized APIs

Specialized APIs are needed to meet specific requirements. For example, the native API history plugin is not sufficient for the transaction volume of the EOS Blockchain. 

To ensure a long lifetime of the specialized EOSIO infrastructure, funding for its maintenance and further development must be ensured. In addition, external teams familiar with EOSIO should be brought on board to maximize resilience for developers. 


4. Central API Service

Fund a dedicated team to provide API services and act as a public resource to bring new developers and companies into the ecosystem. These services are: 


  • Website/Brand: website creation for interested parties (informing, onboarding)

  • Public Peering: establishing reliable connectivity for operators

  • Public API Access: assessing Limited Access for basic use

  • Public Downloads: Data operators to launch own service

  • Documentation: provide support for operators and developers

  • Customer service: provide support for operators and developers when using services




Distributed API

The API+ working group proposes that 5 specialized teams dedicate themselves to creating a white paper that addresses how to develop a DAO that promotes the operation of a wide variety of APIs on EOS and other EOSIO blockchains.


Blockchain Data Depot

This is about making blockchain data from infrastructure providers available for download to the public at standardized time intervals on a homepage such as ENF website or EOSIO to make it easier for newcomers to build their own blockchain infrastructure.




Rosetta

Creating a Rosetta integration for EOSIO would make it much easier to list EOSIO project tokens on Exchanges by eliminating the need to program middleware. This would lead to maximization of liquidity.



The Graph

Some of the largest DeFi applications on ETH and other EVM-compatible chains use The Graph to provide their user dashboards with rich data and visual representations for detailed data charts (e.g.: token price, 24h trading volume, TVL).

 The goal is to develop the software required to integrate The Graph protocols into EOSIO to enable the creation of new data sets.




The API+ working group concluded:

"In the previous chapters, we have only scratched the surface of the topics that have been and can be explored. We hope that we have provided enough information for the community to come to a consensus that we keep the fragile parts of the EOSIO ecosystem stable and move forward with modernization expeditiously."

Want to dive deep into the API+ Bluepaper? View the full bluepaper here.


In order to immerse yourself even deeper into the Blue Papers please read the other articles of this series "Are you ready for the New EOS" in the EOS Support Media Collection.

Have we sparked your curiosity?

Join the EOS movement now and get started by creating your first free EOS Account!


Want to start developing on EOS?
Visit the Antelope website and the EOS Support Learning Center Developer section to learn more


If you liked this article, please consider following the EOS Support Twitter in your language for more up-to-date information, our EOS Support LIVE Giveaway Show, and our Scam Prevention Alert, where we expose the newest fraud schemes in the EOS scene. All our content is provided in 9 different languages, thanks to our international team of highly motivated agents. Want to get involved as well? We are always scouting for talent! Read here


Sources & References

Did this answer your question?