Skip to content

Commit

Permalink
docs: update info to match spec v0.6 (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
scarmuega authored Jul 12, 2024
1 parent ee9ff72 commit af2f881
Show file tree
Hide file tree
Showing 11 changed files with 659 additions and 409 deletions.
2 changes: 1 addition & 1 deletion pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"type": "separator",
"title": "Specification"
},
"build": "Build Module",
"query": "Query Module",
"submit": "Submit Module",
"sync": "Sync Module",
"watch": "Watch Module",
Expand Down
51 changes: 0 additions & 51 deletions pages/build/intro.mdx

This file was deleted.

159 changes: 0 additions & 159 deletions pages/build/spec.mdx

This file was deleted.

4 changes: 2 additions & 2 deletions pages/clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Oura is a stream processing pipeline for Cardano. It's a tool that reads data fr
| Module | Status |
| ------- | -------------- |
| Sync | ✅ supported |
| Build | ⏺️ not required |
| Query | ⏺️ not required |
| Submit | ⏺️ not required |
| Watch | ⏺️ not required |
| Cardano | ✅ supported |
Expand All @@ -21,7 +21,7 @@ Scrolls is a data indexer for Cardano. It's a tool that reads blocks from the Ca
| Module | Status |
| ------- | -------------- |
| Sync | ✅ supported |
| Build | ⏺️ not required |
| Query | ⏺️ not required |
| Submit | ⏺️ not required |
| Watch | ⏺️ not required |
| Cardano | ✅ supported |
Expand Down
4 changes: 2 additions & 2 deletions pages/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Please note that UTxO RPC is just a specification of an interface between agents
The interface is divided into different modules that represent specific use-cases. Not every client will be interested in every module and not every provider will be serving every module.

<Cards>
<Card title="Build Module" icon="🛠️&nbsp;" href="build/intro" />
<Card title="Submit Module" icon="&nbsp;" href="submit/intro" />
<Card title="Query Module" icon="🔍&nbsp;" href="build/intro" />
<Card title="Submit Module" icon="&nbsp;" href="submit/intro" />
<Card title="Sync Module" icon="🔄&nbsp;" href="sync/intro" />
<Card title="Watch Module" icon="👀&nbsp;" href="watch/intro" />
</Cards>
Expand Down
41 changes: 41 additions & 0 deletions pages/query/intro.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import { Callout } from "nextra-theme-docs";

# Query Module

The _Query_ module provides an interface for querying the state of the ledger with the main goal of constructing new transactions.

## Operations

- `ReadParams`: Read chain-wide parameters.
- `ReadUtxos`: Read specific UTxOs by reference.
- `SearchUtxos`: Search for UTxO based on a pattern.
- `ReadData`: Read specific data (plural of datum) by hash.

<Callout type="info">
The schema details can be found in the [spec reference](spec).
</Callout>

## Sequence Example

```mermaid
%%{init: { 'theme': 'dark' } }%%
sequenceDiagram
actor Client
participant QueryService
Note over Client,QueryService: query params to define fees / other criteria
Client->>+QueryService: ReadParams (field_mask)
QueryService-->>-Client: <param>[]
Note over Client,QueryService: read UTxO by ref to resolve tx inputs
Client->>+QueryService: ReadUtxos (refs)
QueryService-->>-Client: ReadUtxos (utxos)
Note over Client,QueryService: query UTxO by address to balance tx
Client->>+QueryService: SearchUtxos (address_pattern)
QueryService-->>-Client: SearchUtxos (utxos)
Note over Client,QueryService: query UTxO by token used as beacon
Client->>+QueryService: SearchUtxos (token_pattern)
QueryService-->>-Client: SearchUtxos (utxos)
```
Loading

0 comments on commit af2f881

Please sign in to comment.