Alien Worlds logo

Dive Into the APIs: Your Ultimate Digital Tool Chest!

To empower our community with essential resources to make it easier to build within the Alien Worlds metaverse, we are excited to introduce a series of REST API tools. These tools will allow players and developers alike to tap into the data of the metaverse, granting them a competitive edge to build, compete, and maximize their application, game, or tool. Whether you're a developer aiming to craft new integrations or a player curious about the behind-the-scenes mechanics, these API tools are your treasure trove.

Before we commence this journey through the toolkit, it's essential to understand the structure of our exploration. We'll unravel key libraries that form the backbone of Alien World's ecosystem, look at their specific roles, and spotlight the DAO API's significance. Whether you're just getting your feet wet or diving deep into the technical abyss, this guide will give you a brief overview of the product and links to comprehensive resources.

Key Libraries and Their Roles

aw-api-dao: This is the entry point where API (Application Programming Interface) consumers would connect to the data specific to the DAOs that have been collected, processed, and stored by the other key libraries in the API tools.

aw-history-dao: This is the component focused on collecting and processing history data related to the DAOs to be hosted in the API.

aw-api-history-starter-kit: This is a preconfigured library that helps new users get started with their own history tools. This would be the place to start if you have different smart contracts with valuable historical data to be tracked and later retrieved.

aw-core: These are foundational elements, offering templates and shared code that are used in other components. A good software principle is DRY (Don’t repeat yourself) and this common library of reusable code is used internally across the API tools.

aw-storage-mongodb: The data processed by the history tools needs to be stored in a database for quick retrieval by API consumers. This provides the adapter tools necessary to plug into MongoDB. It could be adapted to allow an API developer to use any DB of their choice by forking and modifying this library for their own needs.

aw-antelope: All efforts with our API have been centered around connecting to Antelope blockchains such as Wax. This library provides the Antelope-specific connectors needed to plug into the blockchain. However, the architecture is flexible enough to allow the use of alternative connectors, enabling these tools to be used for EVM or other blockchain protocols without requiring a complete rewrite of everything in the toolkit.

aw-workers: When processing vast quantities of raw data from the blockchain, one processing machine may not be enough to keep up with the blockchain that ever marches on with new blocks. Being able to coordinate and distribute the workload across multiple virtual machines may be necessary and this library provides the necessary tools to choreograph such a data symphony.

aw-broadcast: This library is used to facilitate inter-process communication of data. Consider an instance where the history tools are processing a large amount of historical data for its own needs, while another service (running on a different virtual machine) needs just a small piece of that data and doesn’t require the rest. Therefore, rather than needing to run another full instance of history tools, being able to broadcast specific pieces of data can be quicker and more efficient. This also lays the groundwork for implementing Push Notifications in the future.

aliengen: This tool converts the format of blockchain smart contract actions and tables into type-safe TypeScript code interfaces. This minimizes developer error when bridging API code with the blockchain for both reading and writing, thereby enhancing the developer experience and speeding up the development process.

aw-contracts: The output from the aliengen tool is actual Typescript code that is then usable throughout the other libraries. We have created such code libraries from the generated output. Community projects with their own smart contracts could create further libraries in a similar re-usable format with the same tools.

These libraries are designed to interlock perfectly, ensuring data, like game actions and achievements, is fetched rapidly and presented in a player-friendly manner.

Special Mention: DAO API v2.0.0

This tool is purpose-built for developers to directly engage with Planetary Syndicate data. It's a dedicated portal, enabling a deeper grasp of the intricate mechanics of the DAOs. For those with a technical inclination, multiple environments are available to tinker with, and thorough documentation can be found here.

Getting Started

For those eager to dive deeper into the metaverse's mechanics, an array of resources and guides are at your disposal. You can set up the tools, understand their health and functionality, and leverage them for personal projects or utilities.

The API tools provided by Alien Worlds are more than just digital resources. They're gateways to empower users to construct, thrive, and claim prominence in the Alien Worlds ecosystem. As the metaverse grows and evolves, these tools stand as beacons, illuminating paths to new opportunities and experiences.

Excited to learn more? Ready to harness the potential of these tools? Click here to explore the extensive documentation and tutorials. Embark on your journey today!

Be on the Lookout!

The Alien Worlds API will be featured in an upcoming hackathon collaboratively hosted with the Alien Worlds Community. Sign up to receive up to date info on this and all Metaversal events on the Interplanetary Unconference website.