-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update info to match spec v0.6 (#21)
- Loading branch information
Showing
11 changed files
with
659 additions
and
409 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
``` |
Oops, something went wrong.