mirror of
https://github.com/corda/corda.git
synced 2025-02-04 02:01:13 +00:00
Regen docsite
This commit is contained in:
parent
4fd4a348cb
commit
2dcd9c223a
20
docs/build/html/_sources/data-model.txt
vendored
20
docs/build/html/_sources/data-model.txt
vendored
@ -30,17 +30,23 @@ arguments to the verify function. Each command has a list of **public keys** ass
|
|||||||
that the transaction is signed by every key listed in the commands before the contracts start to execute. Public keys
|
that the transaction is signed by every key listed in the commands before the contracts start to execute. Public keys
|
||||||
may be random/identityless for privacy, or linked to a well known legal identity via a *public key infrastructure* (PKI).
|
may be random/identityless for privacy, or linked to a well known legal identity via a *public key infrastructure* (PKI).
|
||||||
|
|
||||||
Note that there is nothing that explicitly binds together specific inputs, outputs or commands. Instead it's up to the
|
Commands are always embedded inside a transaction. Sometimes, there's a larger piece of data that can be reused across
|
||||||
contract code to interpret the pieces inside the transaction and ensure they fit together correctly. This is done to
|
many different transactions. For this use case, we have **attachments**. Every transaction can refer to zero or more
|
||||||
maximise flexibility for the contract developer.
|
attachments by hash. Attachments are always ZIP/JAR files, which may contain arbitrary content. Contract code can then
|
||||||
|
access the attachments by opening them as a JarInputStream (this is temporary and will change later).
|
||||||
|
|
||||||
|
Note that there is nothing that explicitly binds together specific inputs, outputs, commands or attachments. Instead
|
||||||
|
it's up to the contract code to interpret the pieces inside the transaction and ensure they fit together correctly. This
|
||||||
|
is done to maximise flexibility for the contract developer.
|
||||||
|
|
||||||
Transactions may sometimes need to provide a contract with data from the outside world. Examples may include stock
|
Transactions may sometimes need to provide a contract with data from the outside world. Examples may include stock
|
||||||
prices, facts about events or the statuses of legal entities (e.g. bankruptcy), and so on. The providers of such
|
prices, facts about events or the statuses of legal entities (e.g. bankruptcy), and so on. The providers of such
|
||||||
facts are called **oracles** and they provide facts to the ledger by signing transactions that contain commands they
|
facts are called **oracles** and they provide facts to the ledger by signing transactions that contain commands they
|
||||||
recognise. The commands contain the fact and the signature shows agreement to that fact. Time is also modelled as
|
recognise, or by creating signed attachments. The commands contain the fact and the signature shows agreement to that fact.
|
||||||
a fact, with the signature of a special kind of oracle called a **timestamping authority** (TSA). A TSA signs
|
Time is also modelled as a fact, with the signature of a special kind of oracle called a **timestamping authority** (TSA).
|
||||||
a transaction if a pre-defined timestamping command in it defines a after/before time window that includes "true
|
A TSA signs a transaction if a pre-defined timestamping command in it defines a after/before time window that includes
|
||||||
time" (i.e. GPS time as calibrated to the US Naval Observatory).
|
"true time" (i.e. GPS time as calibrated to the US Naval Observatory). An oracle may prefer to generate a signed
|
||||||
|
attachment if the fact it's creating is relatively static and may be referred to over and over again.
|
||||||
|
|
||||||
As the same terminology often crops up in different distributed ledger designs, let's compare this to other
|
As the same terminology often crops up in different distributed ledger designs, let's compare this to other
|
||||||
distributed ledger systems you may be familiar with. You can find more detailed design rationales for why the platform
|
distributed ledger systems you may be familiar with. You can find more detailed design rationales for why the platform
|
||||||
|
1
docs/build/html/_sources/index.txt
vendored
1
docs/build/html/_sources/index.txt
vendored
@ -28,6 +28,7 @@ Read on to learn:
|
|||||||
data-model
|
data-model
|
||||||
messaging
|
messaging
|
||||||
running-the-trading-demo
|
running-the-trading-demo
|
||||||
|
node-administration
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
41
docs/build/html/_sources/node-administration.txt
vendored
Normal file
41
docs/build/html/_sources/node-administration.txt
vendored
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
Node administration
|
||||||
|
===================
|
||||||
|
|
||||||
|
When a node is running, it exposes an embedded web server that lets you monitor it, upload and download attachments,
|
||||||
|
access a REST API and so on.
|
||||||
|
|
||||||
|
Uploading and downloading attachments
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
Attachments are files that add context to and influence the behaviour of transactions. They are always identified by
|
||||||
|
hash and they are public, in that they propagate through the network to wherever they are needed.
|
||||||
|
|
||||||
|
All attachments are zip files. Thus to upload a file to the ledger you must first wrap it into a zip (or jar) file. Then
|
||||||
|
you can upload it by running this command from a UNIX terminal:
|
||||||
|
|
||||||
|
.. sourcecode:: shell
|
||||||
|
|
||||||
|
curl -F myfile=@path/to/my/file.zip http://localhost:31338/attachments/upload
|
||||||
|
|
||||||
|
The attachment will be identified by the SHA-256 hash of the contents, which you can get by doing:
|
||||||
|
|
||||||
|
.. sourcecode:: shell
|
||||||
|
|
||||||
|
shasum -a 256 file.zip
|
||||||
|
|
||||||
|
on a Mac or by using ``sha256sum`` on Linux. Alternatively, check the node logs. There is presently no way to manage
|
||||||
|
attachments from a GUI.
|
||||||
|
|
||||||
|
An attachment may be downloaded by fetching:
|
||||||
|
|
||||||
|
.. sourcecode:: shell
|
||||||
|
|
||||||
|
http://localhost:31338/attachments/DECD098666B9657314870E192CED0C3519C2C9D395507A238338F8D003929DE9
|
||||||
|
|
||||||
|
where DECD... is of course replaced with the hash identifier of your own attachment. Because attachments are always
|
||||||
|
containers, you can also fetch a specific file within the attachment by appending its path, like this:
|
||||||
|
|
||||||
|
.. sourcecode:: shell
|
||||||
|
|
||||||
|
http://localhost:31338/attachments/DECD098666B9657314870E192CED0C3519C2C9D395507A238338F8D003929DE9/path/within/zip.txt
|
||||||
|
|
1
docs/build/html/codestyle.html
vendored
1
docs/build/html/codestyle.html
vendored
@ -87,6 +87,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
|
20
docs/build/html/data-model.html
vendored
20
docs/build/html/data-model.html
vendored
@ -93,6 +93,7 @@
|
|||||||
</li>
|
</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
@ -173,16 +174,21 @@ the platform does not interpret itself, but which can parameterise execution of
|
|||||||
arguments to the verify function. Each command has a list of <strong>public keys</strong> associated with it. The platform ensures
|
arguments to the verify function. Each command has a list of <strong>public keys</strong> associated with it. The platform ensures
|
||||||
that the transaction is signed by every key listed in the commands before the contracts start to execute. Public keys
|
that the transaction is signed by every key listed in the commands before the contracts start to execute. Public keys
|
||||||
may be random/identityless for privacy, or linked to a well known legal identity via a <em>public key infrastructure</em> (PKI).</p>
|
may be random/identityless for privacy, or linked to a well known legal identity via a <em>public key infrastructure</em> (PKI).</p>
|
||||||
<p>Note that there is nothing that explicitly binds together specific inputs, outputs or commands. Instead it’s up to the
|
<p>Commands are always embedded inside a transaction. Sometimes, there’s a larger piece of data that can be reused across
|
||||||
contract code to interpret the pieces inside the transaction and ensure they fit together correctly. This is done to
|
many different transactions. For this use case, we have <strong>attachments</strong>. Every transaction can refer to zero or more
|
||||||
maximise flexibility for the contract developer.</p>
|
attachments by hash. Attachments are always ZIP/JAR files, which may contain arbitrary content. Contract code can then
|
||||||
|
access the attachments by opening them as a JarInputStream (this is temporary and will change later).</p>
|
||||||
|
<p>Note that there is nothing that explicitly binds together specific inputs, outputs, commands or attachments. Instead
|
||||||
|
it’s up to the contract code to interpret the pieces inside the transaction and ensure they fit together correctly. This
|
||||||
|
is done to maximise flexibility for the contract developer.</p>
|
||||||
<p>Transactions may sometimes need to provide a contract with data from the outside world. Examples may include stock
|
<p>Transactions may sometimes need to provide a contract with data from the outside world. Examples may include stock
|
||||||
prices, facts about events or the statuses of legal entities (e.g. bankruptcy), and so on. The providers of such
|
prices, facts about events or the statuses of legal entities (e.g. bankruptcy), and so on. The providers of such
|
||||||
facts are called <strong>oracles</strong> and they provide facts to the ledger by signing transactions that contain commands they
|
facts are called <strong>oracles</strong> and they provide facts to the ledger by signing transactions that contain commands they
|
||||||
recognise. The commands contain the fact and the signature shows agreement to that fact. Time is also modelled as
|
recognise, or by creating signed attachments. The commands contain the fact and the signature shows agreement to that fact.
|
||||||
a fact, with the signature of a special kind of oracle called a <strong>timestamping authority</strong> (TSA). A TSA signs
|
Time is also modelled as a fact, with the signature of a special kind of oracle called a <strong>timestamping authority</strong> (TSA).
|
||||||
a transaction if a pre-defined timestamping command in it defines a after/before time window that includes “true
|
A TSA signs a transaction if a pre-defined timestamping command in it defines a after/before time window that includes
|
||||||
time” (i.e. GPS time as calibrated to the US Naval Observatory).</p>
|
“true time” (i.e. GPS time as calibrated to the US Naval Observatory). An oracle may prefer to generate a signed
|
||||||
|
attachment if the fact it’s creating is relatively static and may be referred to over and over again.</p>
|
||||||
<p>As the same terminology often crops up in different distributed ledger designs, let’s compare this to other
|
<p>As the same terminology often crops up in different distributed ledger designs, let’s compare this to other
|
||||||
distributed ledger systems you may be familiar with. You can find more detailed design rationales for why the platform
|
distributed ledger systems you may be familiar with. You can find more detailed design rationales for why the platform
|
||||||
differs from existing systems in <a class="reference external" href="https://r3-cev.atlassian.net/wiki/">the R3 wiki</a>, but to summarise, the driving
|
differs from existing systems in <a class="reference external" href="https://r3-cev.atlassian.net/wiki/">the R3 wiki</a>, but to summarise, the driving
|
||||||
|
1
docs/build/html/genindex.html
vendored
1
docs/build/html/genindex.html
vendored
@ -87,6 +87,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
|
1
docs/build/html/getting-set-up.html
vendored
1
docs/build/html/getting-set-up.html
vendored
@ -92,6 +92,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
|
5
docs/build/html/index.html
vendored
5
docs/build/html/index.html
vendored
@ -87,6 +87,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
@ -183,6 +184,10 @@ prove or disprove the following hypothesis:</p>
|
|||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="node-administration.html#uploading-and-downloading-attachments">Uploading and downloading attachments</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<div class="toctree-wrapper compound" id="tutorials">
|
<div class="toctree-wrapper compound" id="tutorials">
|
||||||
|
1
docs/build/html/inthebox.html
vendored
1
docs/build/html/inthebox.html
vendored
@ -92,6 +92,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
|
1
docs/build/html/messaging.html
vendored
1
docs/build/html/messaging.html
vendored
@ -93,6 +93,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
|
249
docs/build/html/node-administration.html
vendored
Normal file
249
docs/build/html/node-administration.html
vendored
Normal file
@ -0,0 +1,249 @@
|
|||||||
|
|
||||||
|
|
||||||
|
<!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 administration — R3 Prototyping latest documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="top" title="R3 Prototyping latest documentation" href="index.html"/>
|
||||||
|
<link rel="next" title="Writing a contract" href="tutorial.html"/>
|
||||||
|
<link rel="prev" title="Running the trading demo" href="running-the-trading-demo.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 Prototyping
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<p class="caption"><span class="caption-text">Overview</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<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="data-model.html">Data model</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="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="current reference internal" href="">Node administration</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#uploading-and-downloading-attachments">Uploading and downloading attachments</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Writing a contract</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="protocol-state-machines.html">Protocol state machines</a></li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Appendix</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="visualiser.html">Using the visualiser</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="roadmap.html">Roadmap</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="codestyle.html">Code style guide</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 Prototyping</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 administration</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
|
||||||
|
|
||||||
|
<a href="_sources/node-administration.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-administration">
|
||||||
|
<h1>Node administration<a class="headerlink" href="#node-administration" title="Permalink to this headline">¶</a></h1>
|
||||||
|
<p>When a node is running, it exposes an embedded web server that lets you monitor it, upload and download attachments,
|
||||||
|
access a REST API and so on.</p>
|
||||||
|
<div class="section" id="uploading-and-downloading-attachments">
|
||||||
|
<h2>Uploading and downloading attachments<a class="headerlink" href="#uploading-and-downloading-attachments" title="Permalink to this headline">¶</a></h2>
|
||||||
|
<p>Attachments are files that add context to and influence the behaviour of transactions. They are always identified by
|
||||||
|
hash and they are public, in that they propagate through the network to wherever they are needed.</p>
|
||||||
|
<p>All attachments are zip files. Thus to upload a file to the ledger you must first wrap it into a zip (or jar) file. Then
|
||||||
|
you can upload it by running this command from a UNIX terminal:</p>
|
||||||
|
<div class="highlight-shell"><div class="highlight"><pre>curl -F <span class="nv">myfile</span><span class="o">=</span>@path/to/my/file.zip http://localhost:31338/attachments/upload
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p>The attachment will be identified by the SHA-256 hash of the contents, which you can get by doing:</p>
|
||||||
|
<div class="highlight-shell"><div class="highlight"><pre>shasum -a <span class="m">256</span> file.zip
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p>on a Mac or by using <code class="docutils literal"><span class="pre">sha256sum</span></code> on Linux. Alternatively, check the node logs. There is presently no way to manage
|
||||||
|
attachments from a GUI.</p>
|
||||||
|
<p>An attachment may be downloaded by fetching:</p>
|
||||||
|
<div class="highlight-shell"><div class="highlight"><pre>http://localhost:31338/attachments/DECD098666B9657314870E192CED0C3519C2C9D395507A238338F8D003929DE9
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p>where DECD... is of course replaced with the hash identifier of your own attachment. Because attachments are always
|
||||||
|
containers, you can also fetch a specific file within the attachment by appending its path, like this:</p>
|
||||||
|
<div class="highlight-shell"><div class="highlight"><pre>http://localhost:31338/attachments/DECD098666B9657314870E192CED0C3519C2C9D395507A238338F8D003929DE9/path/within/zip.txt
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer>
|
||||||
|
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||||
|
|
||||||
|
<a href="tutorial.html" class="btn btn-neutral float-right" title="Writing a contract" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
|
<a href="running-the-trading-demo.html" class="btn btn-neutral" title="Running the trading demo" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>
|
||||||
|
© Copyright 2015, R3 CEV.
|
||||||
|
|
||||||
|
</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>
|
1
docs/build/html/protocol-state-machines.html
vendored
1
docs/build/html/protocol-state-machines.html
vendored
@ -88,6 +88,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
|
1
docs/build/html/roadmap.html
vendored
1
docs/build/html/roadmap.html
vendored
@ -88,6 +88,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
|
@ -31,7 +31,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<link rel="top" title="R3 Prototyping latest documentation" href="index.html"/>
|
<link rel="top" title="R3 Prototyping latest documentation" href="index.html"/>
|
||||||
<link rel="next" title="Writing a contract" href="tutorial.html"/>
|
<link rel="next" title="Node administration" href="node-administration.html"/>
|
||||||
<link rel="prev" title="Networking and messaging" href="messaging.html"/>
|
<link rel="prev" title="Networking and messaging" href="messaging.html"/>
|
||||||
|
|
||||||
|
|
||||||
@ -88,6 +88,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="">Running the trading demo</a></li>
|
<li class="toctree-l1 current"><a class="current reference internal" href="">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
@ -174,7 +175,7 @@ flags or another.</p>
|
|||||||
|
|
||||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||||
|
|
||||||
<a href="tutorial.html" class="btn btn-neutral float-right" title="Writing a contract" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="node-administration.html" class="btn btn-neutral float-right" title="Node administration" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="messaging.html" class="btn btn-neutral" title="Networking and messaging" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="messaging.html" class="btn btn-neutral" title="Networking and messaging" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
1
docs/build/html/search.html
vendored
1
docs/build/html/search.html
vendored
@ -86,6 +86,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
|
2
docs/build/html/searchindex.js
vendored
2
docs/build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
5
docs/build/html/tutorial.html
vendored
5
docs/build/html/tutorial.html
vendored
@ -32,7 +32,7 @@
|
|||||||
|
|
||||||
<link rel="top" title="R3 Prototyping latest documentation" href="index.html"/>
|
<link rel="top" title="R3 Prototyping latest documentation" href="index.html"/>
|
||||||
<link rel="next" title="Protocol state machines" href="protocol-state-machines.html"/>
|
<link rel="next" title="Protocol state machines" href="protocol-state-machines.html"/>
|
||||||
<link rel="prev" title="Running the trading demo" href="running-the-trading-demo.html"/>
|
<link rel="prev" title="Node administration" href="node-administration.html"/>
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
<script src="_static/js/modernizr.min.js"></script>
|
||||||
@ -88,6 +88,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
@ -868,7 +869,7 @@ be implemented once in a separate contract, with the controlling data being held
|
|||||||
<a href="protocol-state-machines.html" class="btn btn-neutral float-right" title="Protocol state machines" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="protocol-state-machines.html" class="btn btn-neutral float-right" title="Protocol state machines" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="running-the-trading-demo.html" class="btn btn-neutral" title="Running the trading demo" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="node-administration.html" class="btn btn-neutral" title="Node administration" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
1
docs/build/html/visualiser.html
vendored
1
docs/build/html/visualiser.html
vendored
@ -88,6 +88,7 @@
|
|||||||
<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="data-model.html">Data model</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="messaging.html">Networking and messaging</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="running-the-trading-demo.html">Running the trading demo</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user