Include a Ceramic page in the data indexers developer docs category #802
Conversation
…of Linea documentation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@jlwllmr is attempting to deploy a commit to the Infura Web Team on Vercel. A member of the Team first needs to authorize it. |
|
|
||
| This guide will demonstrate how to use OrbisDB, an open-source relational database that inherits data ownership, composability, and the decentralized properties of the network it’s built on (Ceramic). OrbisDB offers many developer-friendly features in a highly scalable way, including multiple ways to query data, a built-in dashboard UI, shared nodes for testing and iteration, and an ecosystem of plugins that extend its data functionality. | ||
|
|
||
| This guide will also show developers how to use the on-chain event listener plugin to index events from a Linea smart contract. |
There was a problem hiding this comment.
| This guide will also show developers how to use the on-chain event listener plugin to index events from a Linea smart contract. | |
| This guide will also show developers how to use the onchain event listener plugin to index events from a Linea smart contract. |
|
|
||
| This guide will also show developers how to use the on-chain event listener plugin to index events from a Linea smart contract. | ||
|
|
||
| ## Getting Started |
There was a problem hiding this comment.
| ## Getting Started | |
| ## Get started |
| image: /img/socialCards/ceramic.jpg | ||
| --- | ||
|
|
||
| ## Blockchain Event Indexing with OrbisDB on Ceramic |
There was a problem hiding this comment.
| ## Blockchain Event Indexing with OrbisDB on Ceramic | |
| ## Blockchain event indexing with OrbisDB on Ceramic |
There was a problem hiding this comment.
we use sentence case for headings; from what I could see, the words I've changed are not a product/feature name? If they are, and should be capitalised, feel free to ignore this!
|
|
||
| ### Exploring the Studio view | ||
|
|
||
| The OrbisDB studio interface is split into 4 parts: |
There was a problem hiding this comment.
| The OrbisDB studio interface is split into 4 parts: | |
| The OrbisDB Studio interface is split into 4 parts: |
|
|
||
| Visit the [OrbisDB Studio](https://studio.useorbis.com/) in your browser to get started. If it is your first time to the shared studio, you will likely see the following screen: | ||
|
|
||
|  |
There was a problem hiding this comment.
the socialCards directory is for programmatically generated images that display on socials via the page metadata — for any other images, could you please create an appropriate directory in static/img/article-images and update the paths accordingly in this page?
I appreciate the static/img directory is not very clear, we intend to tidy this up soon.
|
|
||
| This is where our data will appear once records are made using our node endpoints and environment ID. You can also query your data using this view (which will be explored later in this guide). | ||
|
|
||
| **Model Builder** |
There was a problem hiding this comment.
| **Model Builder** | |
| **Model builder** |
|
|
||
| Finally, the model builder allows developers to design and deploy new schemas to their OrbisDB instance. | ||
|
|
||
| ### Create a New Context |
There was a problem hiding this comment.
| ### Create a New Context | |
| ### Create a new context |
|
|
||
| Create a new context in the "Contexts" tab by clicking "Add context". You can name this context whatever you prefer. | ||
|
|
||
| ### Configure the Event Listener Plugin |
There was a problem hiding this comment.
| ### Configure the Event Listener Plugin | |
| ### Configure the event listener Plugin |
|
|
||
| Now that you've established a new context you can set up your plugin. Navigate to the "Plugins" tab in the studio view and click on the "Linea Event Listener" plugin. | ||
|
|
||
| Once on the plugin page, you'll notice instructions conveniently listed for you: |
There was a problem hiding this comment.
is the colon intentional? It reads like there could be something missing after this sentence.
|
|
||
| Once ready, click the "Save" button to save your plugin configuration. | ||
|
|
||
| ## Viewing and Querying Data |
There was a problem hiding this comment.
| ## Viewing and Querying Data | |
| ## Viewing and querying data |
This PR includes a new tutorial showcasing how Linea developers can leverage an OrbisDB plugin to listen to and index blockchain events for any smart contract using OrbisDB (a database product on the Ceramic Network).