Skip to content

Commit

Permalink
deploy: eaf551c
Browse files Browse the repository at this point in the history
  • Loading branch information
KtorZ committed Sep 26, 2024
1 parent c5d2323 commit eafd65b
Show file tree
Hide file tree
Showing 313 changed files with 1,285 additions and 1,285 deletions.
2 changes: 1 addition & 1 deletion 404.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!doctype html><html lang=en class="js csstransforms3d"><head><meta charset=utf-8><meta name=description content="User manual for Ogmios, a lightweight protocol translation service for Cardano."><meta name=author content="KtorZ <[email protected]>"><link rel=icon href=/images/favicon.png type=image/png><title>404 Page not found</title><link href=/css/nucleus.css?1726940140 rel=stylesheet><link href=/css/fontawesome-all.min.css?1726940140 rel=stylesheet><link href=/css/hybrid.css?1726940140 rel=stylesheet><link href=/css/featherlight.min.css?1726940140 rel=stylesheet><link href=/css/perfect-scrollbar.min.css?1726940140 rel=stylesheet><link href=/css/theme.css?1726940140 rel=stylesheet><link href=/css/hugo-theme.css?1726940140 rel=stylesheet><link href=/css/theme-mine.css?1726940140 rel=stylesheet><style>:root #header+#content>#left>#rlblock_left{display:none!important}p,li,ul{text-align:center}ul{list-style-type:none}</style><style type=text/css>table.clients img{width:96px!important;height:96px!important}@media(max-width:900px){table.clients tr{display:flex;flex-direction:column}table.clients img{width:128px!important;height:128px!important}}table.users{text-align:center;table-layout:fixed;border:none;border-collapse:collapse}table.users td{padding:0;border:none}table.users img{min-width:100px;max-width:100px;max-height:100px;margin:1rem auto!important;border-radius:50%}@media(max-width:1200px){table.users img{min-width:70px;max-width:70px;max-height:70px;margin:.75rem auto!important}table.users tr:nth-child(2n){display:none}}@media(max-width:900px){table.users img{min-width:60px;max-width:60px;max-height:60px;margin:.5rem auto!important}}@media(max-width:500px){table.users img{min-width:40px;max-width:40px;max-height:40px;margin:.5rem .25rem}}</style></head><body data-url=/><section id=body style=margin-left:0><div id=overlay></div><div id=chapter><div id=body-inner><h1>Error</h1><p></p><p>Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.</p><p></p><p><a href=/>Go to homepage</a></p><p><img src=/images/gopher-404.jpg style=width:50% alt="Page not found!"></p></div></div></section></body></html>
<!doctype html><html lang=en class="js csstransforms3d"><head><meta charset=utf-8><meta name=description content="User manual for Ogmios, a lightweight protocol translation service for Cardano."><meta name=author content="KtorZ <[email protected]>"><link rel=icon href=/images/favicon.png type=image/png><title>404 Page not found</title><link href=/css/nucleus.css?1727361368 rel=stylesheet><link href=/css/fontawesome-all.min.css?1727361368 rel=stylesheet><link href=/css/hybrid.css?1727361368 rel=stylesheet><link href=/css/featherlight.min.css?1727361368 rel=stylesheet><link href=/css/perfect-scrollbar.min.css?1727361368 rel=stylesheet><link href=/css/theme.css?1727361368 rel=stylesheet><link href=/css/hugo-theme.css?1727361368 rel=stylesheet><link href=/css/theme-mine.css?1727361368 rel=stylesheet><style>:root #header+#content>#left>#rlblock_left{display:none!important}p,li,ul{text-align:center}ul{list-style-type:none}</style><style type=text/css>table.clients img{width:96px!important;height:96px!important}@media(max-width:900px){table.clients tr{display:flex;flex-direction:column}table.clients img{width:128px!important;height:128px!important}}table.users{text-align:center;table-layout:fixed;border:none;border-collapse:collapse}table.users td{padding:0;border:none}table.users img{min-width:100px;max-width:100px;max-height:100px;margin:1rem auto!important;border-radius:50%}@media(max-width:1200px){table.users img{min-width:70px;max-width:70px;max-height:70px;margin:.75rem auto!important}table.users tr:nth-child(2n){display:none}}@media(max-width:900px){table.users img{min-width:60px;max-width:60px;max-height:60px;margin:.5rem auto!important}}@media(max-width:500px){table.users img{min-width:40px;max-width:40px;max-height:40px;margin:.5rem .25rem}}</style></head><body data-url=/><section id=body style=margin-left:0><div id=overlay></div><div id=chapter><div id=body-inner><h1>Error</h1><p></p><p>Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.</p><p></p><p><a href=/>Go to homepage</a></p><p><img src=/images/gopher-404.jpg style=width:50% alt="Page not found!"></p></div></div></section></body></html>
6 changes: 3 additions & 3 deletions api/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/v5.6/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/v6.0/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/v6.1/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/v6.2/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/v6.3/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/v6.4/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/v6.5/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/v6.6/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/v6.7/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions categories/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions changelog/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions clients/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions faq/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions getting-started/basics/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!doctype html><html lang=en class="js csstransforms3d"><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=generator content="Hugo 0.76.5"><meta name=description content="User manual for Ogmios, a lightweight protocol translation service for Cardano."><meta name=author content="KtorZ <[email protected]>"><link rel=icon href=/images/favicon.png type=image/png><title>Using: JSON-RPC basics - Ogmios</title><link href=/css/nucleus.css?1726940140 rel=stylesheet><link href=/css/fontawesome-all.min.css?1726940140 rel=stylesheet><link href=/css/hybrid.css?1726940140 rel=stylesheet><link href=/css/featherlight.min.css?1726940140 rel=stylesheet><link href=/css/perfect-scrollbar.min.css?1726940140 rel=stylesheet><link href=/css/auto-complete.css?1726940140 rel=stylesheet><link href=/css/atom-one-dark-reasonable.css?1726940140 rel=stylesheet><link href=/css/theme.css?1726940140 rel=stylesheet><link href=/css/tabs.css?1726940140 rel=stylesheet><link href=/css/hugo-theme.css?1726940140 rel=stylesheet><link href=/css/theme-mine.css?1726940140 rel=stylesheet><script src=/js/jquery-3.3.1.min.js?1726940140></script><style>:root #header+#content>#left>#rlblock_left{display:none!important}</style><style type=text/css>table.clients img{width:96px!important;height:96px!important}@media(max-width:900px){table.clients tr{display:flex;flex-direction:column}table.clients img{width:128px!important;height:128px!important}}table.users{text-align:center;table-layout:fixed;border:none;border-collapse:collapse}table.users td{padding:0;border:none}table.users img{min-width:100px;max-width:100px;max-height:100px;margin:1rem auto!important;border-radius:50%}@media(max-width:1200px){table.users img{min-width:70px;max-width:70px;max-height:70px;margin:.75rem auto!important}table.users tr:nth-child(2n){display:none}}@media(max-width:900px){table.users img{min-width:60px;max-width:60px;max-height:60px;margin:.5rem auto!important}}@media(max-width:500px){table.users img{min-width:40px;max-width:40px;max-height:40px;margin:.5rem .25rem}}</style></head><body data-url=/getting-started/basics/><nav id=sidebar><div id=header-wrapper><div id=header><a href=/><img alt=ogmios src=/ogmios__light.png></a></div><div class=searchbox><label for=search-by><i class="fas fa-search"></i></label><input data-search-input id=search-by type=search placeholder=Search...>
<span data-search-clear><i class="fas fa-times"></i></span></div><script type=text/javascript src=/js/lunr.min.js?1726940140></script><script type=text/javascript src=/js/auto-complete.js?1726940140></script><script type=text/javascript>var baseurl="https:\/\/ogmios.dev";</script><script type=text/javascript src=/js/search.js?1726940140></script></div><div class=highlightable><ul class=topics><li data-nav-id=/getting-started/ title="Getting started" class="dd-item
<!doctype html><html lang=en class="js csstransforms3d"><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=generator content="Hugo 0.76.5"><meta name=description content="User manual for Ogmios, a lightweight protocol translation service for Cardano."><meta name=author content="KtorZ <[email protected]>"><link rel=icon href=/images/favicon.png type=image/png><title>Using: JSON-RPC basics - Ogmios</title><link href=/css/nucleus.css?1727361368 rel=stylesheet><link href=/css/fontawesome-all.min.css?1727361368 rel=stylesheet><link href=/css/hybrid.css?1727361368 rel=stylesheet><link href=/css/featherlight.min.css?1727361368 rel=stylesheet><link href=/css/perfect-scrollbar.min.css?1727361368 rel=stylesheet><link href=/css/auto-complete.css?1727361368 rel=stylesheet><link href=/css/atom-one-dark-reasonable.css?1727361368 rel=stylesheet><link href=/css/theme.css?1727361368 rel=stylesheet><link href=/css/tabs.css?1727361368 rel=stylesheet><link href=/css/hugo-theme.css?1727361368 rel=stylesheet><link href=/css/theme-mine.css?1727361368 rel=stylesheet><script src=/js/jquery-3.3.1.min.js?1727361368></script><style>:root #header+#content>#left>#rlblock_left{display:none!important}</style><style type=text/css>table.clients img{width:96px!important;height:96px!important}@media(max-width:900px){table.clients tr{display:flex;flex-direction:column}table.clients img{width:128px!important;height:128px!important}}table.users{text-align:center;table-layout:fixed;border:none;border-collapse:collapse}table.users td{padding:0;border:none}table.users img{min-width:100px;max-width:100px;max-height:100px;margin:1rem auto!important;border-radius:50%}@media(max-width:1200px){table.users img{min-width:70px;max-width:70px;max-height:70px;margin:.75rem auto!important}table.users tr:nth-child(2n){display:none}}@media(max-width:900px){table.users img{min-width:60px;max-width:60px;max-height:60px;margin:.5rem auto!important}}@media(max-width:500px){table.users img{min-width:40px;max-width:40px;max-height:40px;margin:.5rem .25rem}}</style></head><body data-url=/getting-started/basics/><nav id=sidebar><div id=header-wrapper><div id=header><a href=/><img alt=ogmios src=/ogmios__light.png></a></div><div class=searchbox><label for=search-by><i class="fas fa-search"></i></label><input data-search-input id=search-by type=search placeholder=Search...>
<span data-search-clear><i class="fas fa-times"></i></span></div><script type=text/javascript src=/js/lunr.min.js?1727361368></script><script type=text/javascript src=/js/auto-complete.js?1727361368></script><script type=text/javascript>var baseurl="https:\/\/ogmios.dev";</script><script type=text/javascript src=/js/search.js?1727361368></script></div><div class=highlightable><ul class=topics><li data-nav-id=/getting-started/ title="Getting started" class="dd-item
parent"><a href=/getting-started/><b>1. </b>Getting started</a><ul><li data-nav-id=/getting-started/building/ title="Building / Installation" class=dd-item><a href=/getting-started/building/>Building / Installation</a></li><li data-nav-id=/getting-started/configuring/ title=Configuring class=dd-item><a href=/getting-started/configuring/>Configuring</a></li><li data-nav-id=/getting-started/docker/ title="Running with Docker" class=dd-item><a href=/getting-started/docker/>Running with Docker</a></li><li data-nav-id=/getting-started/monitoring/ title=Monitoring class=dd-item><a href=/getting-started/monitoring/>Monitoring</a></li><li data-nav-id=/getting-started/basics/ title="Using: JSON-RPC basics" class="dd-item active"><a href=/getting-started/basics/>Using: JSON-RPC basics</a></li></ul></li><li data-nav-id=/mini-protocols/ title=Mini-Protocols class=dd-item><a href=/mini-protocols/><b>2. </b>Mini-Protocols</a><ul><li data-nav-id=/mini-protocols/local-chain-sync/ title="Chain synchronization" class=dd-item><a href=/mini-protocols/local-chain-sync/>Chain synchronization</a></li><li data-nav-id=/mini-protocols/local-state-query/ title="Ledger state queries" class=dd-item><a href=/mini-protocols/local-state-query/>Ledger state queries</a></li><li data-nav-id=/mini-protocols/local-tx-submission/ title="Transaction submission" class=dd-item><a href=/mini-protocols/local-tx-submission/>Transaction submission</a></li><li data-nav-id=/mini-protocols/local-tx-monitor/ title="Mempool monitoring" class=dd-item><a href=/mini-protocols/local-tx-monitor/>Mempool monitoring</a></li></ul></li><li data-nav-id=/clients/ title=Clients class=dd-item><a href=/clients/><b>3. </b>Clients</a></li><li data-nav-id=/api/ title="WebSocket API Reference (v6.8.*)" class=dd-item><a href=/api/><b>4. </b>WebSocket API Reference (v6.8.*)</a><ul><li data-nav-id=/api/v6.7/ title="Archive (v6.7.*)" class=dd-item><a href=/api/v6.7/>Archive (v6.7.*)</a></li><li data-nav-id=/api/v6.6/ title="Archive (v6.6.*)" class=dd-item><a href=/api/v6.6/>Archive (v6.6.*)</a></li><li data-nav-id=/api/v6.5/ title="Archive (v6.5.*)" class=dd-item><a href=/api/v6.5/>Archive (v6.5.*)</a></li><li data-nav-id=/api/v6.4/ title="Archive (v6.4.*)" class=dd-item><a href=/api/v6.4/>Archive (v6.4.*)</a></li><li data-nav-id=/api/v6.3/ title="Archive (v6.3.*)" class=dd-item><a href=/api/v6.3/>Archive (v6.3.*)</a></li><li data-nav-id=/api/v6.2/ title="Archive (v6.2.*)" class=dd-item><a href=/api/v6.2/>Archive (v6.2.*)</a></li><li data-nav-id=/api/v6.1/ title="Archive (v6.1.*)" class=dd-item><a href=/api/v6.1/>Archive (v6.1.*)</a></li><li data-nav-id=/api/v6.0/ title="Archive (v6.0.*)" class=dd-item><a href=/api/v6.0/>Archive (v6.0.*)</a></li><li data-nav-id=/api/v5.6/ title="Archive (v5.6.*)" class=dd-item><a href=/api/v5.6/>Archive (v5.6.*)</a></li></ul></li><li data-nav-id=/http-api/ title="HTTP API Reference (v6.8.*)" class=dd-item><a href=/http-api/><b>5. </b>HTTP API Reference (v6.8.*)</a></li><li data-nav-id=/changelog/ title=Changelog class=dd-item><a href=/changelog/><b>6. </b>Changelog</a></li><li data-nav-id=/faq/ title=F.A.Q class=dd-item><a href=/faq/><b>6. </b>F.A.Q</a></li></ul><section id=shortcuts><h3>More</h3><ul><li><a class=padding href=https://github.com/cardanosolutions/ogmios><i class="fab fa-github"></i>Source code</a></li><li><a class=padding href=https://github.com/cardanosolutions/ogmios/issues><i class="fas fa-solid fa-bullseye"></i>Issues Tracking</a></li><li><a class=padding href=https://discord.gg/zMr6EGvBpr><i class="fab fa-discord"></i>Discord (#ogmios)</a></li><li><a class=padding href=https://github.com/CardanoSolutions/ogmios/tree/master/architectural-decisions/accepted><i class="fas fa-solid fa-file-code"></i>Architectural Decisions Record</a></li><li><a class=padding href=https://github.com/CardanoSolutions/ogmios/tree/master/server/test/vectors><i class="fas fa-solid fa-vector-square"></i>Test vectors</a></li></ul></section><section id=footer><p>Built with <a href=https://github.com/matcornic/hugo-theme-learn><i class="fas fa-heart"></i></a>from <a href=https://getgrav.org>Grav</a> and <a href=https://gohugo.io/>Hugo</a></p></section></div></nav><section id=body><div id=overlay></div><div class="padding highlightable"><div><div id=top-bar><div id=breadcrumbs itemscope itemtype=http://data-vocabulary.org/Breadcrumb><span id=sidebar-toggle-span><a href=# id=sidebar-toggle data-sidebar-toggle><i class="fas fa-bars"></i></a></span><span id=toc-menu><i class="fas fa-list-alt"></i></span><span class=links><a href=/>Overview</a> > <a href=/getting-started/>Getting started</a> > Using: JSON-RPC basics</span></div><div class=progress><div class=wrapper><nav id=TableOfContents><ul><li><a href=#json-rpc>JSON-RPC</a><ul><li><a href=#requests>Requests</a></li><li><a href=#responses>Responses</a></li></ul></li><li><a href=#websocket-vs-http>WebSocket vs HTTP</a><ul><li><a href=#websocket>WebSocket</a></li><li><a href=#http>HTTP</a></li></ul></li></ul></nav></div></div></div></div><div id=head-tags></div><div id=body-inner><h1>Using: JSON-RPC basics</h1><h2 id=json-rpc>JSON-RPC</h2><p>Ogmios' interface is built on top of <a href=https://www.jsonrpc.org/specification>JSON-RPC 2.0</a> which is a tiny standard to give some structure to the various messages that can be exchanged with Ogmios. The standard specifies a top-level JSON envelope by which messages must abide, as well as a semantic for some of the fields. It well suited for request/response types of protocols, such as any of the Ouroboros mini-protocols spoken by Ogmios.</p><p>We won&rsquo;t be covering the JSON-RPC standard in this guide but gives a few extra insights about how it relates to Ogmios and some good takes from it. The standard is however relatively small so we encourage you to spare 5 minutes and quickly go through it when you find an opportunity.</p><p>Each request in Ogmios yields exactly one response, might it be a <em>success</em> response or an <em>error</em> response. Furthermore, requests which relate to a particular protocol are guaranteed to yield responses in the same order.</p><h3 id=requests>Requests</h3><p>Requests messages are sent by client applications (you) to Ogmios. Requests have 3 fields of interest: <code>method</code>, <code>params</code> and <code>id</code>. The <code>method</code> identifies the request itself and translates to a corresponding message of one of the 3 Ouroboros mini-protocols. Possible values for <code>method</code> are described in <a href=../../mini-protocols>section 3 - Ouroboros mini-protocols</a> and the complete reference is available in <a href=../../api>section 4 - API Reference</a>. The <code>params</code> specify extra parameters that apply to the given <code>method</code>.</p><p>Here is an example of valid request message:</p><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-json data-lang=json>{
<span style=color:#f92672>&#34;jsonrpc&#34;</span>: <span style=color:#e6db74>&#34;2.0&#34;</span>,
<span style=color:#f92672>&#34;method&#34;</span>: <span style=color:#e6db74>&#34;findIntersection&#34;</span>,
Expand Down Expand Up @@ -50,4 +50,4 @@

<span style=color:#75715e>// do something with &#39;response&#39;
</span><span style=color:#75715e></span>});
</code></pre></div><p>That&rsquo;s all for the basics. The rest isn&rsquo;t really specific to Ogmios, but is about the Ouroboros mini-protocols themselves. See the next sections for a deep dive!</p><footer class=footline></footer></div></div><div id=navigation><a class="nav nav-prev" href=/getting-started/monitoring/ title=Monitoring><i class="fa fa-chevron-left"></i></a><a class="nav nav-next" href=/mini-protocols/ title=Mini-Protocols style=margin-right:0><i class="fa fa-chevron-right"></i></a></div></section><div style=left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px><div style=border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px></div></div><script src=/js/clipboard.min.js?1726940140></script><script src=/js/perfect-scrollbar.min.js?1726940140></script><script src=/js/perfect-scrollbar.jquery.min.js?1726940140></script><script src=/js/jquery.sticky.js?1726940140></script><script src=/js/featherlight.min.js?1726940140></script><script src=/js/highlight.pack.js?1726940140></script><script>hljs.initHighlightingOnLoad();</script><script src=/js/modernizr.custom-3.6.0.js?1726940140></script><script src=/js/learn.js?1726940140></script><script src=/js/hugo-learn.js?1726940140></script></body></html>
</code></pre></div><p>That&rsquo;s all for the basics. The rest isn&rsquo;t really specific to Ogmios, but is about the Ouroboros mini-protocols themselves. See the next sections for a deep dive!</p><footer class=footline></footer></div></div><div id=navigation><a class="nav nav-prev" href=/getting-started/monitoring/ title=Monitoring><i class="fa fa-chevron-left"></i></a><a class="nav nav-next" href=/mini-protocols/ title=Mini-Protocols style=margin-right:0><i class="fa fa-chevron-right"></i></a></div></section><div style=left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px><div style=border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px></div></div><script src=/js/clipboard.min.js?1727361368></script><script src=/js/perfect-scrollbar.min.js?1727361368></script><script src=/js/perfect-scrollbar.jquery.min.js?1727361368></script><script src=/js/jquery.sticky.js?1727361368></script><script src=/js/featherlight.min.js?1727361368></script><script src=/js/highlight.pack.js?1727361368></script><script>hljs.initHighlightingOnLoad();</script><script src=/js/modernizr.custom-3.6.0.js?1727361368></script><script src=/js/learn.js?1727361368></script><script src=/js/hugo-learn.js?1727361368></script></body></html>
Loading

0 comments on commit eafd65b

Please sign in to comment.