mirror of
https://github.com/corda/corda.git
synced 2024-12-23 06:42:33 +00:00
364 lines
16 KiB
HTML
364 lines
16 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Node Explorer — R3 Corda latest documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
|
<link rel="next" title="Initial Margin Agreements" href="initial-margin-agreement.html"/>
|
|
<link rel="prev" title="Network Simulator" href="network-simulator.html"/>
|
|
|
|
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home"> R3 Corda
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
latest
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
<br>
|
|
<a href="api/index.html">API reference</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
<p class="caption"><span class="caption-text">Getting started</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="inthebox.html">What’s included?</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-set-up.html">Getting set up</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="running-the-demos.html">Running the demos</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Key concepts</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="data-model.html">Data model</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="transaction-data-types.html">Data types</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="merkle-trees.html">Transaction Tear-offs</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="consensus.html">Consensus model</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">The Corda node</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="clientrpc.html">Client RPC</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="messaging.html">Networking and messaging</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="persistence.html">Persistence</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="corda-configuration-files.html">The Corda Configuration File</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="corda-plugins.html">The Corda Plugin Framework</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="node-services.html">A Brief Introduction To The Node Services</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">CorDapps</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html">Creating a Cordapp</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html#gradle-plugins-for-cordapps">Gradle Plugins for Cordapps</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="where-to-start.html">Where to start</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract.html">Writing a contract</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract-clauses.html">Writing a contract using clauses</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-test-dsl.html">Writing a contract test</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-clientrpc-api.html">Client RPC API Tutorial</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="flow-state-machines.html">Writing flows</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="flow-testing.html">Writing flow tests</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="oracles.html">Writing oracle services</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-attachments.html">Using attachments</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="event-scheduling.html">Event scheduling</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Other</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="network-simulator.html">Network Simulator</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Node Explorer</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#running-the-ui">Running the UI</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#running-demo-nodes">Running Demo Nodes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#interface">Interface</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="initial-margin-agreement.html">Initial Margin Agreements</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Component library</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="contract-catalogue.html">Contract catalogue</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="contract-irs.html">Interest Rate Swaps</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Appendix</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="loadtesting.html">Load testing</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="secure-coding-guidelines.html">Secure coding guidelines</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release-process.html">Release process</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release-process.html#steps-to-cut-a-release">Steps to cut a release</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release notes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="codestyle.html">Code style guide</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="building-the-docs.html">Building the documentation</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Glossary</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">R3 Corda</a>
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html">Docs</a> »</li>
|
|
|
|
<li>Node Explorer</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/node-explorer.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="node-explorer">
|
|
<h1>Node Explorer<a class="headerlink" href="#node-explorer" title="Permalink to this headline">¶</a></h1>
|
|
<p>The node explorer provide views to the node’s vault and transaction data using Corda’s RPC framework.
|
|
The user can execute cash transaction commands to issue and move cash to other party on the network or exit cash using the user interface.</p>
|
|
<div class="section" id="running-the-ui">
|
|
<h2>Running the UI<a class="headerlink" href="#running-the-ui" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Windows</strong>:</p>
|
|
<div class="highlight-kotlin"><div class="highlight"><pre><span></span><span class="n">gradlew</span><span class="p">.</span><span class="n">bat</span> <span class="n">tools</span><span class="p">:</span><span class="n">explorer</span><span class="p">:</span><span class="n">run</span>
|
|
</pre></div>
|
|
</div>
|
|
<p><strong>Other</strong>:</p>
|
|
<div class="highlight-kotlin"><div class="highlight"><pre><span></span><span class="p">./</span><span class="n">gradlew</span> <span class="n">tools</span><span class="p">:</span><span class="n">explorer</span><span class="p">:</span><span class="n">run</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="running-demo-nodes">
|
|
<h2>Running Demo Nodes<a class="headerlink" href="#running-demo-nodes" title="Permalink to this headline">¶</a></h2>
|
|
<p><strong>Windows</strong>:</p>
|
|
<div class="highlight-kotlin"><div class="highlight"><pre><span></span><span class="n">gradlew</span><span class="p">.</span><span class="n">bat</span> <span class="n">tools</span><span class="p">:</span><span class="n">explorer</span><span class="p">:</span><span class="n">runDemoNodes</span>
|
|
</pre></div>
|
|
</div>
|
|
<p><strong>Other</strong>:</p>
|
|
<div class="highlight-kotlin"><div class="highlight"><pre><span></span><span class="p">./</span><span class="n">gradlew</span> <span class="n">tools</span><span class="p">:</span><span class="n">explorer</span><span class="p">:</span><span class="n">runDemoNodes</span>
|
|
</pre></div>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p>3 Corda nodes will be created on the following port on localhost by default.</p>
|
|
<ul class="last simple">
|
|
<li>Notary -> 20002</li>
|
|
<li>Alice -> 20004</li>
|
|
<li>Bob -> 20006</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="interface">
|
|
<h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="docutils">
|
|
<dt>Login</dt>
|
|
<dd>User can login to any Corda node using the explorer. Alternatively, <code class="docutils literal"><span class="pre">gradlew</span> <span class="pre">explorer:runDemoNodes</span></code> can be used to start up demo nodes for testing.
|
|
Corda node address, username and password are required for login, the address is defaulted to localhost:0 if leave blank.
|
|
Username and password can be configured via the <code class="docutils literal"><span class="pre">rpcUsers</span></code> field in node’s configuration file; for demo nodes, it is defaulted to <code class="docutils literal"><span class="pre">user1</span></code> and <code class="docutils literal"><span class="pre">test</span></code>.</dd>
|
|
</dl>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">If you are connecting to the demo nodes, only Alice and Bob (20004, 20006) are accessible using user1 credential, you won’t be able to connect to the notary.</p>
|
|
</div>
|
|
<a class="reference internal image-reference" href="_images/login.png"><img alt="_images/login.png" class="align-center" src="_images/login.png" style="width: 520.0px; height: 599.0px;" /></a>
|
|
<dl class="docutils">
|
|
<dt>Dashboard</dt>
|
|
<dd>The dashboard shows the top level state of node and vault.
|
|
Currently, it shows your cash balance and the numbers of transaction executed.
|
|
The dashboard is intended to house widgets from different CordApp’s and provide useful information to system admin at a glance.</dd>
|
|
</dl>
|
|
<img alt="_images/dashboard.png" src="_images/dashboard.png" />
|
|
<dl class="docutils">
|
|
<dt>Cash</dt>
|
|
<dd>The cash view shows all currencies you currently own in a tree table format, it is grouped by issuer -> currency.
|
|
Individual cash transactions can be viewed by clicking on the table row. The user can also use the search field to narrow down the scope.</dd>
|
|
</dl>
|
|
<img alt="_images/vault.png" src="_images/vault.png" />
|
|
<dl class="docutils">
|
|
<dt>New cash transaction</dt>
|
|
<dd>This is where you can create new cash transactions.
|
|
The user can choose from three transaction types (issue, pay and exit) and any party visible on the network.
|
|
The result of the transaction will be visible in the transaction screen when executed.</dd>
|
|
</dl>
|
|
<img alt="_images/newTransaction.png" src="_images/newTransaction.png" />
|
|
<dl class="docutils">
|
|
<dt>Transactions</dt>
|
|
<dd>The transaction view contains all transactions handled by the node in a table view. It shows basic information on the table e.g. Transaction ID,
|
|
command type, USD equivalence value etc. User can expand the row by double clicking to view the inputs,
|
|
outputs and the signatures details for that transaction.</dd>
|
|
</dl>
|
|
<img alt="_images/transactionView.png" src="_images/transactionView.png" />
|
|
<dl class="docutils">
|
|
<dt>Network</dt>
|
|
<dd>The network view shows the network information on the world map. Currently only the user’s node is rendered on the map.
|
|
This will be extended to other peers in a future release.
|
|
The map provides a intuitive way of visualizing the Corda network and the participants.</dd>
|
|
</dl>
|
|
<img alt="_images/network.png" src="_images/network.png" />
|
|
<dl class="docutils">
|
|
<dt>Settings</dt>
|
|
<dd>User can configure the client preference in this view.</dd>
|
|
</dl>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">Although the reporting currency is configurable, FX conversion won’t be applied to the values as we don’t have an FX service yet.</p>
|
|
</div>
|
|
<img alt="_images/settings.png" src="_images/settings.png" />
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="initial-margin-agreement.html" class="btn btn-neutral float-right" title="Initial Margin Agreements" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="network-simulator.html" class="btn btn-neutral" title="Network Simulator" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2016, Distributed Ledger Group, LLC.
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'./',
|
|
VERSION:'latest',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |