Merge branch 'master' of github.com:airalab/aira

airalab · Jul 31, 2019 · f9866a5 · f9866a5
2 parents d7525ab + 65c8525
commit f9866a5
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 2 deletions.
diff --git a/docs/img/Robonomics_Scheme.png b/docs/img/Robonomics_Scheme.png
diff --git a/docs/img/provider-mobilerobotics-demand-offer.png b/docs/img/provider-mobilerobotics-demand-offer.png
diff --git a/docs/img/provider-mobilerobotics-liability.png b/docs/img/provider-mobilerobotics-liability.png
diff --git a/docs/robonomics_network/become_a_provider.rst b/docs/robonomics_network/become_a_provider.rst
@@ -84,3 +84,24 @@ You must install `robonomics-tools <https://github.com/airalab/robonomics-tools>
 .. hint::
 
     Get familiar with the `xrtd` options via ``xrtd --help``
+
+Test the provider
+-----------------
+
+To test your provider go again to the lighthouse `dapp <https://dapp.robonomics.network/#/lighthouse/>`_ and connect to the just created lighthouse.
+
+At the bottom you should see the `TEST LIGHTHOUSE` section.
+
+Click on the `Demand` button and then on the `Offer` one. You should see something similar to:
+
+.. image:: ../img/provider-mobilerobotics-demand-offer.png
+  :alt: Demand and Offer messages
+  :align: center
+
+Don't forget to sign every message with the MetaMask extension.
+
+Finally you should see a new liability contract created:
+
+.. image:: ../img/provider-mobilerobotics-liability.png
+  :alt: Liability is created
+  :align: center
diff --git a/docs/robonomics_network/how_it_works.rst b/docs/robonomics_network/how_it_works.rst
@@ -3,7 +3,20 @@ How It Works
 
 In this section we will discuss the Robonomics Network scenario.
 
-Robonomics Network uses IPFS PubSub channels for messaging. There are three types of messages: Demand, Offer, Result.
+There are few main parts in the Robonomics network:
+
+- IPFS for the messages exchanging
+- the Ethereum blockchain for storing new liability contracts
+- a provider that is responsible for matching messages
+- an agent
+
+Let's have a look at the following diagram that describes the scenario without any additional details:
+
+.. image:: ../img/Robonomics_Scheme.png
+   :alt: The main scenario
+   :align: center
+
+There are three types of `messages <../specs/market_messages.html>`_ in IPFS: Demand, Offer, Result.
 
 **Below there is the specification for a Demand message:**
 
@@ -27,7 +40,7 @@ An Offer message has the same fields but instead of ``validatorFee`` there is a
 Now let's have a look at the following diagram and walk step by step from the moment of publishing messages to a liability finalization.
 
 .. image:: ../img/5.png
-   :alt: Scenario
+   :alt: Detailed scenario
    :align: center
 
 A liability contract is created only if the following fields match: ``model``, ``objective``, ``token``, ``cost``. A provider of Robonomics Network watches every message and finds those ones that have a match.