Skip to content

Commit

Permalink
Deployed 3066c40 to main with MkDocs 1.5.3 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Mar 19, 2024
1 parent 09e04a8 commit bb008ae
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 24 deletions.
30 changes: 15 additions & 15 deletions main/demo/ReusingAConnection/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2191,30 +2191,24 @@ <h1 id="reusing-a-connection">Reusing a Connection<a class="headerlink" href="#r
instruction up to the point where you are about to start the Faber and Alice agents.</p>
<ol>
<li>On a command line, run Faber with these parameters: <code>./run_demo faber
--reuse-connection --events</code>.</li>
--reuse-connections --public-did-connections --events</code>.</li>
<li>On a second command line, run Alice as normal, perhaps with the <code>events</code>
option: <code>./run_demo alice --events</code></li>
option: <code>./run_demo alice --reuse-connections --events</code></li>
<li>Copy the invitation from the Faber terminal and paste it into the Alice
terminal at the prompt.</li>
<li>Verify that the connection was established.</li>
<li>If you want, go to the Alice OpenAPI screen (port <code>8031</code>, path
<code>api/docs</code>), and then use the <code>GET Connections</code> to see that Alice has one
connection to Faber.</li>
<li>In the Faber terminal, type <code>4</code> to get a prompt for a new connection. This
will generate a new invitation with the same public DID.</li>
<li>In the Alice terminal, type <code>4</code> to get a prompt for a new connection, and
paste the same invitation as in Step 3 (above).</li>
paste the new invitation.</li>
<li>Note from the webhook events in the Faber terminal that the <code>reuse</code> message
is received from Alice, and as a result, no new connection was created.</li>
<li>Execute again the <code>GET Connections</code> endpoint on the Alice OpenAPI screen
to confirm that there is still just one established connection.</li>
<li>In the Faber terminal, type <code>4</code> to get a new invitation, copy the invitation,
in the Alice terminal, type <code>4</code> to get prompted for an invitation, and paste
in the new invitation from Faber. Again, the <code>reuse</code> webhook event will be
visible in the Faber terminal.</li>
<li>Execute again the <code>GET Connections</code> endpoint on the Alice OpenAPI screen
to confirm that there is still just one established connection.</li>
<li>Notice that in the invitations in Step 3 and 7 both have the same DID in
the <code>services</code>.</li>
<li>Try running the demo again <strong>without</strong> the <code>--reuse-connection</code> parameter and
<li>Try running the demo again <strong>without</strong> the <code>--reuse-connections</code> parameter and
compare the <code>services</code> value in the new invitation vs. what was generated in
Steps 3 and 7. It is not a DID, but rather a one time use, inline DIDDoc
item.</li>
Expand All @@ -2224,9 +2218,15 @@ <h1 id="reusing-a-connection">Reusing a Connection<a class="headerlink" href="#r
use any <em>resolvable</em> (not inline) DID, including DID Peer types 2 or 4 DIDs, as
long as the DID is the same in every invitation. It is the fact that the DID is
always the same that tells the invitee that they can reuse an existing connection.</p>
<p>Note that the invitation does <strong>NOT</strong> have to be a multi-use invitation for
reuse to be useful, as long as the other requirements (at the top of this
document) are met.</p>
<p>For example, to run faber with connection reuse using a non-public DID:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>./run_demo faber --reuse-connections --events
</code></pre></div>
<p>To run faber using a <code>did_peer</code> and reusable connections:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>DEMO_EXTRA_AGENT_ARGS=&quot;[\&quot;--emit-did-peer-2\&quot;]&quot; ./run_demo faber --reuse-connections --events
</code></pre></div>
<p>To run this demo using a multi-use invitation (from Faber):</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>DEMO_EXTRA_AGENT_ARGS=&quot;[\&quot;--emit-did-peer-2\&quot;]&quot; ./run_demo faber --reuse-connections --multi-use-invitations --events
</code></pre></div>



Expand Down
20 changes: 12 additions & 8 deletions main/demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2673,18 +2673,22 @@ <h3 id="revocation">Revocation<a class="headerlink" href="#revocation" title="Pe
<a id="__codelineno-17-10" name="__codelineno-17-10" href="#__codelineno-17-10"></a>
<a id="__codelineno-17-11" name="__codelineno-17-11" href="#__codelineno-17-11"></a>This will use the new DID Exchange protocol when establishing connections between the agents, rather than the older Connection protocol. There is no other affect on the operation of the agents.
<a id="__codelineno-17-12" name="__codelineno-17-12" href="#__codelineno-17-12"></a>
<a id="__codelineno-17-13" name="__codelineno-17-13" href="#__codelineno-17-13"></a>Note that you can&#39;t (currently) use the DID Exchange protocol to connect with any of the available mobile agents.
<a id="__codelineno-17-13" name="__codelineno-17-13" href="#__codelineno-17-13"></a>With DID Exchange, you can also enable use of the inviter&#39;s public DID for invitations, multi-use invitations, and connection re-use:
<a id="__codelineno-17-14" name="__codelineno-17-14" href="#__codelineno-17-14"></a>
<a id="__codelineno-17-15" name="__codelineno-17-15" href="#__codelineno-17-15"></a>### Endorser
<a id="__codelineno-17-16" name="__codelineno-17-16" href="#__codelineno-17-16"></a>
<a id="__codelineno-17-17" name="__codelineno-17-17" href="#__codelineno-17-17"></a>This is described in [Endorser.md](Endorser.md)
<a id="__codelineno-17-15" name="__codelineno-17-15" href="#__codelineno-17-15"></a>- `--public-did-connections` - use the inviter&#39;s public DID in invitations, and allow use of implicit invitations
<a id="__codelineno-17-16" name="__codelineno-17-16" href="#__codelineno-17-16"></a>- `--reuse-connections` - support connection re-use (invitee will reuse an existing connection if it uses the same DID as in the new invitation)
<a id="__codelineno-17-17" name="__codelineno-17-17" href="#__codelineno-17-17"></a>- `--multi-use-invitations` - inviter will issue multi-use invitations
<a id="__codelineno-17-18" name="__codelineno-17-18" href="#__codelineno-17-18"></a>
<a id="__codelineno-17-19" name="__codelineno-17-19" href="#__codelineno-17-19"></a>### Run Indy-SDK Backend
<a id="__codelineno-17-19" name="__codelineno-17-19" href="#__codelineno-17-19"></a>### Endorser
<a id="__codelineno-17-20" name="__codelineno-17-20" href="#__codelineno-17-20"></a>
<a id="__codelineno-17-21" name="__codelineno-17-21" href="#__codelineno-17-21"></a>This runs using the older (and not recommended) indy-sdk libraries instead of [Aries Askar](https://github.com/hyperledger/aries-ask):
<a id="__codelineno-17-21" name="__codelineno-17-21" href="#__codelineno-17-21"></a>This is described in [Endorser.md](Endorser.md)
<a id="__codelineno-17-22" name="__codelineno-17-22" href="#__codelineno-17-22"></a>
<a id="__codelineno-17-23" name="__codelineno-17-23" href="#__codelineno-17-23"></a>```bash
<a id="__codelineno-17-24" name="__codelineno-17-24" href="#__codelineno-17-24"></a>./run_demo faber --wallet-type indy
<a id="__codelineno-17-23" name="__codelineno-17-23" href="#__codelineno-17-23"></a>### Run Indy-SDK Backend
<a id="__codelineno-17-24" name="__codelineno-17-24" href="#__codelineno-17-24"></a>
<a id="__codelineno-17-25" name="__codelineno-17-25" href="#__codelineno-17-25"></a>This runs using the older (and not recommended) indy-sdk libraries instead of [Aries Askar](https://github.com/hyperledger/aries-ask):
<a id="__codelineno-17-26" name="__codelineno-17-26" href="#__codelineno-17-26"></a>
<a id="__codelineno-17-27" name="__codelineno-17-27" href="#__codelineno-17-27"></a>```bash
<a id="__codelineno-17-28" name="__codelineno-17-28" href="#__codelineno-17-28"></a>./run_demo faber --wallet-type indy
</code></pre></div></p>
<h3 id="mediation">Mediation<a class="headerlink" href="#mediation" title="Permanent link">&para;</a></h3>
<p>To enable mediation, run the <code>alice</code> or <code>faber</code> demo with the <code>--mediation</code> option:</p>
Expand Down
2 changes: 1 addition & 1 deletion main/search/search_index.json

Large diffs are not rendered by default.

Binary file modified main/sitemap.xml.gz
Binary file not shown.

0 comments on commit bb008ae

Please sign in to comment.