Skip to content

Commit

Permalink
deploy: 63d61e6
Browse files Browse the repository at this point in the history
  • Loading branch information
@FabioPinheiro
FabioPinheiro committed Dec 1, 2023
1 parent ea9a028 commit ec2ef2c
Show file tree
Hide file tree
Showing 11 changed files with 446 additions and 285 deletions.
79 changes: 54 additions & 25 deletions test-interoperability.html → 01-about/01-scala-did.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Typelevel Laika + Helium Theme" />
<title>Interoperability</title>
<title>Scala DID</title>


<meta name="description" content="Scala-did a DID Comm library for scala"/>
Expand All @@ -20,9 +20,9 @@

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Fira+Mono:500">

<link rel="stylesheet" type="text/css" href="helium/site/icofont.min.css" />
<link rel="stylesheet" type="text/css" href="helium/site/laika-helium.css" />
<script src="helium/site/laika-helium.js"></script>
<link rel="stylesheet" type="text/css" href="../helium/site/icofont.min.css" />
<link rel="stylesheet" type="text/css" href="../helium/site/laika-helium.css" />
<script src="../helium/site/laika-helium.js"></script>


<script> /* for avoiding page load transitions */ </script>
Expand All @@ -40,7 +40,7 @@

</div>

<a class="icon-link glyph-link" href="index.html"><i class="icofont-laika home" title="Home">&#xef47;</i></a>
<a class="icon-link glyph-link" href="../"><i class="icofont-laika home" title="Home">&#xef47;</i></a>

<div class="row links">

Expand Down Expand Up @@ -87,16 +87,19 @@
</div>

<ul class="nav-list">
<li class="level1 nav-leaf"><a href="example.js.html">Example JS</a></li>
<li class="level1 nav-leaf"><a href="external-documentation.html">External documentation</a></li>
<li class="level1 nav-leaf"><a href="limitations.html">Limitations</a></li>
<li class="level1 nav-leaf"><a href="quickstart-basic-examples.html">Basic Example</a></li>
<li class="level1 nav-leaf"><a href="quickstart-get-started.html">Getting Started with DIDComm Messaging in Scala</a></li>
<li class="level1 nav-leaf"><a href="quickstart-setup-environment.html">Setup environment</a></li>
<li class="level1 nav-leaf"><a href="readme.html">Scala-did</a></li>
<li class="level1 nav-leaf"><a href="test-coverage.html">Test coverage</a></li>
<li class="level1 active nav-leaf"><a href="#">Interoperability</a></li>
<li class="level1 nav-leaf"><a href="troubleshooting.html">Troubleshooting</a></li>
<li class="level1 nav-header">About Scala-DID</li>
<li class="level2 active nav-leaf"><a href="#">Scala DID</a></li>
<li class="level2 nav-leaf"><a href="09-external-documentation.html">External documentation</a></li>
<li class="level1 nav-header">Quickstart Guides</li>
<li class="level2 nav-leaf"><a href="../02-quickstart/01-setup-environment.html">Setup environment</a></li>
<li class="level2 nav-leaf"><a href="../02-quickstart/02-install-dependency.html">Import Library</a></li>
<li class="level2 nav-leaf"><a href="../02-quickstart/03-imports.html">Config imports</a></li>
<li class="level2 nav-leaf"><a href="../02-quickstart/04-basic-examples.html">Basic Example</a></li>
<li class="level2 nav-leaf"><a href="../02-quickstart/05-did-comm-examples.html">Getting Started with DIDComm Messaging</a></li>
<li class="level1 nav-header">Troubleshooting and Limitations</li>
<li class="level2 nav-leaf"><a href="../08-others/limitations.html">Limitations</a></li>
<li class="level2 nav-leaf"><a href="../08-others/test-coverage.html">Test coverage</a></li>
<li class="level2 nav-leaf"><a href="../08-others/troubleshooting.html">Troubleshooting</a></li>
</ul>

</nav>
Expand All @@ -105,29 +108,55 @@


<nav id="page-nav">
<p class="header"><a href="#">Interoperability</a></p>
<p class="header"><a href="#">Scala DID</a></p>

<ul class="nav-list">
<li class="level1 nav-leaf"><a href="#badges">Badges</a></li>
<li class="level1 nav-node"><a href="#design-goals">Design Goals</a></li>
<li class="level2 nav-leaf"><a href="#specification-compliant">Specification compliant</a></li>
<li class="level2 nav-leaf"><a href="#purely-functional">Purely Functional</a></li>
<li class="level2 nav-leaf"><a href="#simples-to-use">Simples to use</a></li>
</ul>

<p class="footer"><a href="https://github.com/FabioPinheiro/scala-did/blob/master/docs/src/test-interoperability.md"><i class="icofont-laika edit" title="Edit">&#xef10;</i>Source for this page</a></p>
<p class="footer"><a href="https://github.com/FabioPinheiro/scala-did/blob/master/docs/src/01-about/01-scala-did.md"><i class="icofont-laika edit" title="Edit">&#xef10;</i>Source for this page</a></p>
</nav>


<main class="content">

<h1 id="interoperability" class="title">Interoperability</h1>
<ul>
<li>With RootsID&#39;s mediator <a href="https://github.com/roots-id/didcomm-mediator/tree/main">https://github.com/roots-id/didcomm-mediator/tree/main</a></li>
</ul>
<ul>
<li>invitation: <code>https://mediator.rootsid.cloud/?_oob=eyJ0eXBlIjoiaHR0cHM6Ly9kaWRjb21tLm9yZy9vdXQtb2YtYmFuZC8yLjAvaW52aXRhdGlvbiIsImlkIjoiNzk0Mjc4MzctY2MwNi00ODUzLWJiMzktNjg2ZWFjM2U2YjlhIiwiZnJvbSI6ImRpZDpwZWVyOjIuRXo2TFNtczU1NVloRnRobjFXVjhjaURCcFptODZoSzl0cDgzV29qSlVteFBHazFoWi5WejZNa21kQmpNeUI0VFM1VWJiUXc1NHN6bTh5dk1NZjFmdEdWMnNRVllBeGFlV2hFLlNleUpwWkNJNkltNWxkeTFwWkNJc0luUWlPaUprYlNJc0luTWlPaUpvZEhSd2N6b3ZMMjFsWkdsaGRHOXlMbkp2YjNSemFXUXVZMnh2ZFdRaUxDSmhJanBiSW1ScFpHTnZiVzB2ZGpJaVhYMCIsImJvZHkiOnsiZ29hbF9jb2RlIjoicmVxdWVzdC1tZWRpYXRlIiwiZ29hbCI6IlJlcXVlc3RNZWRpYXRlIiwibGFiZWwiOiJNZWRpYXRvciIsImFjY2VwdCI6WyJkaWRjb21tL3YyIl19fQ</code></li>
</ul>
<h1 id="scala-did" class="title">Scala DID</h1>
<p>Scala DID is a Scala/ScalaJS library for DID and DIDcomm v2.</p>
<p>DIDComm is a secure messaging protocol for decentralized identities (DIDs).
This library allows you to easily integrate DIDComm messaging into your application.</p>
<p>The one of the main goals of this library is to make DID Comm v2 <strong>type safety</strong> and <strong>easy to use</strong>.</p>
<p>The <a href="https://github.com/FabioPinheiro/scala-did">repository</a> also contes the <a href="https://did.fmgp.app/"><strong>LIVE DEMO (DIDComm&#39;s Sandbox)</strong></a>
The <strong>PoC Mediator</strong> was move to the <a href="https://github.com/input-output-hk/atala-prism-mediator">Atala PRISM DID Comm Mediator</a> where a production ready mediator is being developed and maintain.</p>

<h2 id="badges" class="section"><a class="anchor-link left" href="#badges"><i class="icofont-laika link">&#xef71;</i></a>Badges</h2>
<p><img src="https://img.shields.io/maven-central/v/app.fmgp/did_3" alt="Maven Central">
<a href="https://github.com/FabioPinheiro/scala-did/actions/workflows/ci.yml"><img src="https://github.com/FabioPinheiro/scala-did/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
<a href="https://github.com/FabioPinheiro/scala-did/actions/workflows/scala-steward.yml"><img src="https://github.com/FabioPinheiro/scala-did/actions/workflows/scala-steward.yml/badge.svg" alt="Scala Steward"></a></p>
<p><a href="https://index.scala-lang.org/fabiopinheiro/scala-did/did"><img src="https://index.scala-lang.org/fabiopinheiro/scala-did/did/latest-by-scala-version.svg?platform=jvm" alt="did Scala version support"></a>
<a href="https://index.scala-lang.org/fabiopinheiro/scala-did/did"><img src="https://index.scala-lang.org/fabiopinheiro/scala-did/did/latest-by-scala-version.svg?platform=sjs1" alt="did Scala version support"></a></p>

<h2 id="design-goals" class="section"><a class="anchor-link left" href="#design-goals"><i class="icofont-laika link">&#xef71;</i></a>Design Goals</h2>

<h3 id="specification-compliant" class="section"><a class="anchor-link left" href="#specification-compliant"><i class="icofont-laika link">&#xef71;</i></a>Specification compliant</h3>
<p>We tryied to follow the <a href="https://identity.foundation/didcomm-messaging/spec/">DID Comm Specification</a>.</p>

<h3 id="purely-functional" class="section"><a class="anchor-link left" href="#purely-functional"><i class="icofont-laika link">&#xef71;</i></a>Purely Functional</h3>
<p>The Library API is <strong>purely functional</strong>.
The internal implementetion tries also to be <strong>purely functional</strong>, and any call to the dependency libory (for cryptography) encapsulates and handel the error in a Functional way.
All the error are value so the user know exactly what to expect by the signatures of the methods. </p>

<h3 id="simples-to-use" class="section"><a class="anchor-link left" href="#simples-to-use"><i class="icofont-laika link">&#xef71;</i></a>Simples to use</h3>
<p><code>&quot;But I just want to send/read a message!&quot;</code> - We are create a Framework to facilitate some of the mundane tasks and boilerplate code. Like to open ws connections or making http calls.</p>
<p>We also have an implementation for most of the <a href="https://didcomm.org/">DID Comm Protocalls</a> of the official repository.</p>


<hr class="footer-rule"/>
<footer>
Documentation website for <em>Scala-did</em> a DID Comm library for scala.
Documentation website for <em>Scala-DID</em> a DID Comm library for scala.
</footer>


Expand Down
35 changes: 19 additions & 16 deletions external-documentation.html → 01-about/09-external-documentation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Fira+Mono:500">

<link rel="stylesheet" type="text/css" href="helium/site/icofont.min.css" />
<link rel="stylesheet" type="text/css" href="helium/site/laika-helium.css" />
<script src="helium/site/laika-helium.js"></script>
<link rel="stylesheet" type="text/css" href="../helium/site/icofont.min.css" />
<link rel="stylesheet" type="text/css" href="../helium/site/laika-helium.css" />
<script src="../helium/site/laika-helium.js"></script>


<script> /* for avoiding page load transitions */ </script>
Expand All @@ -40,7 +40,7 @@

</div>

<a class="icon-link glyph-link" href="index.html"><i class="icofont-laika home" title="Home">&#xef47;</i></a>
<a class="icon-link glyph-link" href="../"><i class="icofont-laika home" title="Home">&#xef47;</i></a>

<div class="row links">

Expand Down Expand Up @@ -87,16 +87,19 @@
</div>

<ul class="nav-list">
<li class="level1 nav-leaf"><a href="example.js.html">Example JS</a></li>
<li class="level1 active nav-leaf"><a href="#">External documentation</a></li>
<li class="level1 nav-leaf"><a href="limitations.html">Limitations</a></li>
<li class="level1 nav-leaf"><a href="quickstart-basic-examples.html">Basic Example</a></li>
<li class="level1 nav-leaf"><a href="quickstart-get-started.html">Getting Started with DIDComm Messaging in Scala</a></li>
<li class="level1 nav-leaf"><a href="quickstart-setup-environment.html">Setup environment</a></li>
<li class="level1 nav-leaf"><a href="readme.html">Scala-did</a></li>
<li class="level1 nav-leaf"><a href="test-coverage.html">Test coverage</a></li>
<li class="level1 nav-leaf"><a href="test-interoperability.html">Interoperability</a></li>
<li class="level1 nav-leaf"><a href="troubleshooting.html">Troubleshooting</a></li>
<li class="level1 nav-header">About Scala-DID</li>
<li class="level2 nav-leaf"><a href="01-scala-did.html">Scala DID</a></li>
<li class="level2 active nav-leaf"><a href="#">External documentation</a></li>
<li class="level1 nav-header">Quickstart Guides</li>
<li class="level2 nav-leaf"><a href="../02-quickstart/01-setup-environment.html">Setup environment</a></li>
<li class="level2 nav-leaf"><a href="../02-quickstart/02-install-dependency.html">Import Library</a></li>
<li class="level2 nav-leaf"><a href="../02-quickstart/03-imports.html">Config imports</a></li>
<li class="level2 nav-leaf"><a href="../02-quickstart/04-basic-examples.html">Basic Example</a></li>
<li class="level2 nav-leaf"><a href="../02-quickstart/05-did-comm-examples.html">Getting Started with DIDComm Messaging</a></li>
<li class="level1 nav-header">Troubleshooting and Limitations</li>
<li class="level2 nav-leaf"><a href="../08-others/limitations.html">Limitations</a></li>
<li class="level2 nav-leaf"><a href="../08-others/test-coverage.html">Test coverage</a></li>
<li class="level2 nav-leaf"><a href="../08-others/troubleshooting.html">Troubleshooting</a></li>
</ul>

</nav>
Expand All @@ -110,7 +113,7 @@
<ul class="nav-list">
</ul>

<p class="footer"><a href="https://github.com/FabioPinheiro/scala-did/blob/master/docs/src/external-documentation.md"><i class="icofont-laika edit" title="Edit">&#xef10;</i>Source for this page</a></p>
<p class="footer"><a href="https://github.com/FabioPinheiro/scala-did/blob/master/docs/src/01-about/09-external-documentation.md"><i class="icofont-laika edit" title="Edit">&#xef10;</i>Source for this page</a></p>
</nav>


Expand All @@ -131,7 +134,7 @@ <h1 id="external-documentation" class="title">External documentation</h1>

<hr class="footer-rule"/>
<footer>
Documentation website for <em>Scala-did</em> a DID Comm library for scala.
Documentation website for <em>Scala-DID</em> a DID Comm library for scala.
</footer>


Expand Down
Loading

0 comments on commit ec2ef2c

Please sign in to comment.