Add Submit-API and Ogmios to GRest (#1261)

cardano-community · Jan 9, 2022 · ee064a5 · ee064a5
1 parent 3469c80
commit ee064a5
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 42 deletions.
diff --git a/Build/node-cli/index.html b/Build/node-cli/index.html
@@ -207,6 +207,11 @@
   </a>
 </li>
 <li class="md-nav__item">
+<a class="md-nav__link" href="#start-the-submit-api">
+    Start the submit-api
+  </a>
+</li>
+<li class="md-nav__item">
 <a class="md-nav__link" href="#systemd">
     Run as systemd service
   </a>
@@ -425,6 +430,11 @@
   </a>
 </li>
 <li class="md-nav__item">
+<a class="md-nav__link" href="#start-the-submit-api">
+    Start the submit-api
+  </a>
+</li>
+<li class="md-nav__item">
 <a class="md-nav__link" href="#systemd">
     Run as systemd service
   </a>
@@ -497,22 +507,34 @@ <h4 id="start-the-node">Start the node<a class="headerlink" href="#start-the-nod
 ./cnode.sh
 </code></pre></div></p>
 <p>Stop the node by hitting Ctrl-C.</p>
+<h4 id="start-the-submit-api">Start the submit-api<a class="headerlink" href="#start-the-submit-api" title="Permanent link">⚓︎</a></h4>
+<p><code>cardano-submit-api</code> is one of the binaries built as part of <code>cardano-node</code> repository and allows you to submit transactions over a Web API. To run this service interactively, you can use the pre-built script below (<code>submitapi.sh</code>). Make sure to update <code>submitapi.sh</code> script to change listen IP or Port that you'd want to make this service available on.</p>
+<div class="highlight"><pre><span></span><code><span class="nb">cd</span> <span class="nv">$CNODE_HOME</span>/scripts
+./submitapi.sh
+</code></pre></div>
+<p>To stop the process, hit Ctrl-C</p>
 <h4 id="systemd">Run as systemd service<a class="headerlink" href="#systemd" title="Permanent link">⚓︎</a></h4>
-<p>The preferred way to run the node is through a service manager like systemd. This section explains how to setup a systemd service file.</p>
+<p>The preferred way to run the node (and submit-api) is through a service manager like systemd. This section explains how to setup a systemd service file.</p>
 <p><strong>1. Deploy as a systemd service</strong><br/>
 Execute the below command to deploy your node as a systemd service (from the respective scripts folder):
 <div class="highlight"><pre><span></span><code><span class="nb">cd</span> <span class="nv">$CNODE_HOME</span>/scripts
 ./cnode.sh -d
 <span class="c1"># Deploying cnode.service as systemd service..</span>
 <span class="c1"># cnode.service deployed successfully!!</span>
+
+./submitapi.sh -d
+<span class="c1"># Deploying cnode-submit-api.service as systemd service..</span>
+<span class="c1"># cnode-submit-api deployed successfully!!</span>
 </code></pre></div></p>
-<p><strong>2. Start the node</strong><br/>
+<p><strong>2. Start the service</strong><br/>
 Run below commands to enable automatic start of service on startup and start it.
 <div class="highlight"><pre><span></span><code>sudo systemctl start cnode.service
+sudo systemctl start cnode-submit-api.service
 </code></pre></div></p>
 <p><strong>3. Check status and stop/start commands</strong> 
 Replace <code>status</code> with <code>stop</code>/<code>start</code>/<code>restart</code> depending on what action to take.
 <div class="highlight"><pre><span></span><code>sudo systemctl status cnode.service
+sudo systemctl status cnode-submit-api.service
 </code></pre></div></p>
 <div class="admonition important">
 <p class="admonition-title">Important</p>

diff --git a/basics/index.html b/basics/index.html
@@ -411,7 +411,7 @@ <h5 id="os-prereqs">Set up OS packages, folder structure and fetch files from re
 chmod <span class="m">755</span> prereqs.sh
 </code></pre></div>
 <p>Please familiarise with the syntax of <code>prereqs.sh</code> before proceeding. The usage syntax can be checked using <code>./prereqs.sh -h</code> , sample output below:</p>
-<div class="highlight"><pre><span></span><code>Usage: prereqs.sh <span class="o">[</span>-f<span class="o">]</span> <span class="o">[</span>-s<span class="o">]</span> <span class="o">[</span>-i<span class="o">]</span> <span class="o">[</span>-l<span class="o">]</span> <span class="o">[</span>-c<span class="o">]</span> <span class="o">[</span>-w<span class="o">]</span> <span class="o">[</span>-b &lt;branch&gt;<span class="o">]</span> <span class="o">[</span>-n &lt;mainnet<span class="p">|</span>testnet<span class="p">|</span>guild<span class="p">|</span>staging&gt;<span class="o">]</span> <span class="o">[</span>-t &lt;name&gt;<span class="o">]</span> <span class="o">[</span>-m &lt;seconds&gt;<span class="o">]</span>
+<div class="highlight"><pre><span></span><code>Usage: prereqs.sh <span class="o">[</span>-f<span class="o">]</span> <span class="o">[</span>-s<span class="o">]</span> <span class="o">[</span>-i<span class="o">]</span> <span class="o">[</span>-l<span class="o">]</span> <span class="o">[</span>-c<span class="o">]</span> <span class="o">[</span>-w<span class="o">]</span> <span class="o">[</span>-o<span class="o">]</span> <span class="o">[</span>-b &lt;branch&gt;<span class="o">]</span> <span class="o">[</span>-n &lt;mainnet<span class="p">|</span>testnet<span class="p">|</span>guild<span class="p">|</span>staging&gt;<span class="o">]</span> <span class="o">[</span>-t &lt;name&gt;<span class="o">]</span> <span class="o">[</span>-m &lt;seconds&gt;<span class="o">]</span>
 Install pre-requisites <span class="k">for</span> building cardano-node and using CNTools
 
 -f    Force overwrite of all files including normally saved user config sections in env, cnode.sh and gLiveView.sh
@@ -424,6 +424,7 @@ <h5 id="os-prereqs">Set up OS packages, folder structure and fetch files from re
 -l    Use system libsodium instead of IOG fork <span class="o">(</span>Default: use libsodium from IOG fork<span class="o">)</span>
 -c    Install/Upgrade and build CNCLI with RUST
 -w    Install/Upgrade Vacuumlabs cardano-hw-cli <span class="k">for</span> hardware wallet support
+-o    Install/Upgrade Ogmios Server binary
 -b    Use alternate branch of scripts to download - only recommended <span class="k">for</span> testing/development <span class="o">(</span>Default: master<span class="o">)</span>
 -i    Interactive mode <span class="o">(</span>Default: silent mode<span class="o">)</span>
 </code></pre></div>

diff --git a/build/index.html b/build/index.html
@@ -376,26 +376,30 @@ <h4 id="components">Components<a class="headerlink" href="#components" title="Pe
   C(Manage pool-ops, <br/> asset operation tasks <br/> easily?)
   D(Create Custom Assets?)
   E(Monitor node <br/> using Terminal UI)
-  O(Node)
+  N(Node)
   F(Manage Pool/Wallet Keys<br/>and tx signing<br/>offline)
+  O(Ogmios)
   P(gRest/Koios)
   Q(DBSync)
   R(Wallet)
   S(CNTools)
+  T(Tx Submit API)
   U(GraphQL)
   V(OfflineMetadataTools)
   X(gLiveView)
 
 F --x S
-O --x C --x S
-O --x D
+N --x C --x S
+N --x D
 D --x S
 D --x V
-O --x E --x X
-O --x B
+N --x E --x X
+N --x B
 B --x U --x Q
 B --x P --x Q
-O --x A --x R
+P --x O
+P --x T
+N --x A --x R
 </div>
 <div class="admonition warning">
 <p class="admonition-title">Important</p>

diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml b/sitemap.xml
@@ -2,162 +2,162 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://cardano-community.github.io/guild-operators/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/basics/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/build/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/contributors/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/grest-meets/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/sidebar/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/upgrade/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Appendix/RecoverByronWallet/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Appendix/monitoring/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Appendix/postgres/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Build/dbsync/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Build/graphql/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Build/grest/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Build/node-cli/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Build/offchain-metadata-tools/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Build/wallet/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/cncli/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/cntools-changelog/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/cntools-common/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/cntools/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/env/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/gliveview/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/itnrewards/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/itnwitness/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/logmonitor/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/sendalerts/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/Scripts/topologyupdater/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/docker/build/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/docker/docker/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/docker/run/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/docker/security/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://cardano-community.github.io/guild-operators/docker/tips/</loc>
-         <lastmod>2022-01-03</lastmod>
+         <lastmod>2022-01-09</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz