Hello, community! Continuing our efforts to improve documentation and encourage participation in coding with the Rosetta API, we have added and updated documentation for version 1.4.10. Some of these updates affected the look of the navigation menu. However, section names stayed the same from the last update.
We added a new document, titled Getting Started. This document provides steps to begin a Rosetta implementation or integration.
We’ve updated the following documents in Rosetta API Documentation version 1.4.10. Updates include content and formatting changes. We also added relevant content that had previously only been found in our GitHub repositories.
- Principles — We reduced the content of six of the Principles documents (still available in previous versions) into a more succinct document. This change resulted in a less-visually-cluttered navigation menu. We also added content to the Principles document that we moved over from the rosetta-specifications GitHub repository.
- These documents were updated to remove links to the removed Principles documents:
- Implement All Endpoints
- Common Mistakes
- Automated Deployment and Testing — We streamlined the content for succinctness and clarity.
- The rosetta-cli Tool — Formerly titled rosetta-cli, we updated this document to better describe how the rosetta-cli tool works. This document also contains content that we moved over from the rosetta-cli GitHub repository.
- We made small formatting updates to these documents:
The following documents were removed from version 1.4.10 because we reduced their content and moved it to the new Principles document. The full content still appears in version 1.4.9.
- Universal Read and Write
- No Gatekeepers
- Low-Level Abstractions
- First-Class Support for Sharded Blockchains
- Staking and Smart Contract Support
- JSON-Based RPC Protocol
Remember those hard-to-read flow diagrams in the Flow of Operations, Data API Overview, and Construction API Overview documents? They’re gone. (You’re welcome!) We’ve replaced them with graphic images that are easier for the eyes to follow.
Also, the new Getting Started document includes a Rosetta API Quick Reference Guide. This image provides a visual overview of all the Rosetta API endpoints. Finally, the updated Principles document includes an image moved from the rosetta-specifications GitHub repository. The image shows an example of how multiple Rosetta implementations could work for tracking ethereum transfers and trades.
Recently, we added support for the Pallas curve type to the rosetta-specifications and rosetta-sdk-go repositories. Our next documentation update will include adding this curve type and updating our documentation to version 1.4.12.
We continue to update and publish these documents with you in mind. We want to empower you with knowledge, so that you can walk through the process of creating Rosetta implementations and integrations as independently as possible. Let us know what you liked and what we can improve by replying to this post below. Your comments will help us improve our documentation. Thanks!