Ark Ecosystem's goal is to give everyone the power to easily create, customize and scale their own blockchain networks. By combining innovative network design with accessible & extensible software, Ark Ecosystem allows for maximum developer productivity. We prioritize builders and doers from every walk of life by building blockchain software that balances power and ease of use.
Our documentation is a central hub for all knowledge Ark Ecosystem, and as such it's designed to be useful to readers of all technical backgrounds. If read from cover to cover, you'll learn everything from the basics of blockchain to how to create a blockchain of your own — and much more besides.
Below you can read short summaries of each chapter and the topics you'll find within them. The documentation will be edited and expanded frequently as development continues, so check back often for updates.
This is our introduction to the world of blockchain and Ark's place within it.
Blockchain is a good place to begin if you have little prior experience with blockchain. It answers many common questions about what blockchain is, why it's useful, and how Ark helps make blockchain easier. The Ark section highlights the philosophy behind the Ark Ecosystem blockchain, and how that compares against some of the sector's most popular projects (Bitcoin, Ethereum, etc.)
In this section we describe the software components of the Ark Ecosystem. We focus in particular on Ark Core: the codebase powering the nodes that, in turn, power the Ark network.
Core describes the architecture of Ark Core. At present, the documentation focuses on the packages that allow for easy application and blockchain customization. Contribution Guidelines details the process for contributing to Ark Ecosystem software. Reading this section also helps to understand the coding styles and practices that inform development across the Ecosystem. Guides offers software-specific information on how to develop for Ark Ecosystem. From running your first test suite to submitting pull requests for your code's inclusion into Ark itself, this is the section to read if you're a developer looking to get involved.
The counterpart to the Guidebook, the Cookbook contains practical code snippets and "recipes" (tutorials) to help developers write productive code with the Ark Ecosystem as quickly as possible. We'll always provide context for the code we post here, so you'll have the convenience of copy-and-paste and the knowledge to strike your own path when necessary.
Usage Guides describe how to use the various Ark packages, including:
Deployer is the place to go for code snippets and tutorials related to building your own blockchain. We cover setting up your blockchain and deploying it to major cloud hosting service providers. Exchanges is where developers for cryptocurrency exchanges can find information on how to integrate the ARK coin into their platforms. Though we cannot make any guarantees about the codebases of any projects besides the ARK coin, this recipe should serve as a good starting point for integrating Ark BridgeChain coins as well.
This section describes the structure of all Ark APIs, as well as usage examples. After you've read the Guidebook and Cookbook, this section should be the first place you turn to find out how to interact with the Ark Ecosystem software.
Public API describes the API that's accessible through any Ark node. API references for Ark v1 and v2 are included. The SDK section includes information on how to use any of the Ark API wrappers we've written for supercharged development in your language of choice. Currently, the following SDKs are available:
P2P outlines the functions available to the P2P API.
JSON-RPC contains instructions on how to use the JSON-RPC API to interact with the Ark blockchain. This technology is of particular interest to exchanges looking to use a Bitcoin RPC-like interface to integrate Ark into their platform.
Webhooks describes how to use the webhooks feature of Ark v2 to "listen" to events on the Ark blockchain. This is especially useful for developers who are looking to drive action in their applications in response to specific blockchain events (transactions, vote, etc.)
We answer some of the most common questions about Ark Ecosystem here, from general questions about Ark philosophy to specific tips on how to resolve commonly encountered errors.
Basic definitions of some of the vocabulary used throughout the documentation.