Skip to content

Commit 969d06f

Browse files
authored
build: migrate to the hyperledger-identus (#208)
* docs: add Identus platform specification Signed-off-by: Yurii Shynbuiev <[email protected]> * ci: migrate to hyperledger-identus org Signed-off-by: Yurii Shynbuiev <[email protected]> * fix: links in the docs Signed-off-by: Yurii Shynbuiev <[email protected]> * chore: temporary ignore the broken links Signed-off-by: Yurii Shynbuiev <[email protected]> * chore: update CODEOWNERS Signed-off-by: Yurii Shynbuiev <[email protected]> * revert: add Identus platform specification This reverts commit fae187d. Signed-off-by: Yurii Shynbuiev <[email protected]> --------- Signed-off-by: Yurii Shynbuiev <[email protected]>
1 parent c9273ca commit 969d06f

File tree

9 files changed

+40
-45
lines changed

9 files changed

+40
-45
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1 @@
1-
# These owners will be the default owners for everything in
2-
# the repo. Unless a later match takes precedence
3-
* @petevielhaber @yshyn-iohk @amagyar-iohk @bvoiturier @lohanspies @mkbreuningIOHK @Dale-iohk @elribonazo @essbante-io
4-
5-
# Docs:
6-
*.md @petevielhaber
1+
* @hyperledger-identus/identus-maintainers

.gitmodules

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
[submodule "identus-cloud-agent"]
2-
path = identus-cloud-agent
3-
url = https://github.com/hyperledger/identus-cloud-agent.git
4-
[submodule "identus-edge-agent-sdk-ts"]
5-
path = identus-edge-agent-sdk-ts
6-
url = https://github.com/hyperledger/identus-edge-agent-sdk-ts.git
1+
[submodule "cloud-agent"]
2+
path = cloud-agent
3+
url = https://github.com/hyperledger-identus/cloud-agent
4+
[submodule "edge-agent-sdk-ts"]
5+
path = edge-agent-sdk-ts
6+
url = https://github.com/hyperledger-identus/edge-agent-sdk-ts

documentation/adrs/decisions/2023-01-18-quill-library-for-sql-statement-generation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,5 +175,5 @@ val result: Future[Seq[Person]] = db.run(q.result)
175175
- [Database access libraries in Scala](https://medium.com/@takezoe/database-access-libraries-in-scala-7aa7590aa3db)
176176
- [Typechecking SQL queries with doobie](https://godatadriven.com/blog/typechecking-sql-queries-with-doobie/)
177177
- [Typechecking SQL in Slick and doobie](https://underscore.io/blog/posts/2015/05/28/typechecking-sql.html)
178-
- [Doobie example in the Pollux library](https://github.com/hyperledger/identus-cloud-agent/blob/pollux-v0.17.0/pollux/lib/sql-doobie/src/main/scala/io/iohk/atala/pollux/sql/repository/JdbcCredentialRepository.scala)
179-
- [Quill example in the Pollux library](https://github.com/hyperledger/identus-cloud-agent/blob/pollux-v0.17.0/pollux/lib/sql-doobie/src/main/scala/io/iohk/atala/pollux/sql/model/VerifiableCredentialSchema.scala)
178+
- [Doobie example in the Pollux library](https://github.com/hyperledger-identus/cloud-agent/blob/pollux-v0.17.0/pollux/lib/sql-doobie/src/main/scala/io/iohk/atala/pollux/sql/repository/JdbcCredentialRepository.scala)
179+
- [Quill example in the Pollux library](https://github.com/hyperledger-identus/cloud-agent/blob/pollux-v0.17.0/pollux/lib/sql-doobie/src/main/scala/io/iohk/atala/pollux/sql/model/VerifiableCredentialSchema.scala)

documentation/adrs/decisions/2024-01-16-use-zio-failures-and-defects-effectively.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ way to recover
240240
from an SQL execution error in a database-agnostic way.
241241

242242
A good approach is to use ZIO Defects to report repository errors, declaring all repository methods as `URIO`
243-
or `UIO`([example](https://github.com/hyperledger/identus-cloud-agent/blob/main/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala)).
243+
or `UIO`([example](https://github.com/hyperledger-identus/cloud-agent/blob/main/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala)).
244244
Conversely, declaring them as `Task` assumes that the caller (i.e. service) can properly handle and
245245
recover from the low-level and database-specific exceptions exposed in the error channel, which is a fallacy.
246246

@@ -251,7 +251,7 @@ trait ConnectionRepository {
251251
```
252252

253253
Converting a ZIO `Task` to ZIO `UIO` can easily be done
254-
using `ZIO#orDie`([example](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L114)).
254+
using `ZIO#orDie`([example](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L114)).
255255

256256
```scala
257257
class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[Task]) extends ConnectionRepository {
@@ -276,7 +276,7 @@ class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[
276276
```
277277

278278
For those cases where one has to generate a defect, a common way to do this is by using the following ZIO
279-
construct ([example](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L212)):
279+
construct ([example](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L212)):
280280

281281
```scala
282282
class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[Task]) extends ConnectionRepository {
@@ -293,11 +293,11 @@ class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[
293293
Follow the `get` and `find` best practices in the repository interface for read operations:
294294

295295
- `getXxx()` returns the requested record or throws an unexpected exception/defect when not
296-
found ([example](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala#L36)).
296+
found ([example](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala#L36)).
297297
- `findXxx()` returns an `Option` with or without the request record, which allows the caller service to handle
298298
the `found`
299299
and `not-found` cases and report appropriately to the end
300-
user ([example](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala#L32)).
300+
user ([example](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala#L32)).
301301

302302
```scala
303303
trait ConnectionRepository {
@@ -312,7 +312,7 @@ trait ConnectionRepository {
312312
The `create`, `update` or `delete` repository methods should not return an `Int` indicating the number of rows affected
313313
by the operation but either return `Unit` when successful or throw an exception/defect when the row count is not what is
314314
expected, like i.e. an update operation resulting in a `0` affected row
315-
count ([example](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L85)).
315+
count ([example](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L85)).
316316

317317
```scala
318318
class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[Task]) extends ConnectionRepository {
@@ -358,7 +358,7 @@ caught at the upper level and returns a generic `500 Internal Server Error` to t
358358

359359
For those cases where a specific error like `404` should be returned, it is up to the service to first call `find()`
360360
before `update()` and construct a `NotFound` failure, propagated through the error channel, if it gives
361-
a `None` ([example](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/service/ConnectionServiceImpl.scala#L149)).
361+
a `None` ([example](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/service/ConnectionServiceImpl.scala#L149)).
362362

363363
Relying on the service layer to implement it will guarantee consistent behavior regardless of the underlying database
364364
type (could be different RDMS flavor, No-SQL, etc.).
@@ -382,22 +382,22 @@ class ConnectionServiceImpl() extends ConnectionService {
382382
#### Do not type unexpected errors
383383

384384
Do not wrap defects from lower layers (typically repository) in a failure and error case class declarations
385-
like [this](https://github.com/hyperledger/identus-cloud-agent/blob/b579fd86ab96db711425f511154e74be75583896/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L8)
385+
like [this](https://github.com/hyperledger-identus/cloud-agent/blob/b579fd86ab96db711425f511154e74be75583896/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L8)
386386
should be prohibited.
387387

388388
Considering that failures are viewed as **expected errors** from which users can potentially recover, error case classes
389389
like `UnexpectedError` should be
390-
prohibited ([example](https://github.com/hyperledger/identus-cloud-agent/blob/b579fd86ab96db711425f511154e74be75583896/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L12)).
390+
prohibited ([example](https://github.com/hyperledger-identus/cloud-agent/blob/b579fd86ab96db711425f511154e74be75583896/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L12)).
391391

392392
#### Extend the common `Failure` trait
393393

394394
Make sure all service errors extend the shared
395-
trait [`org.hyperledger.identus.shared.models.Failure`](https://github.com/hyperledger/identus-cloud-agent/blob/main/shared/src/main/scala/io/iohk/atala/shared/models/Failure.scala).
395+
trait [`org.hyperledger.identus.shared.models.Failure`](https://github.com/hyperledger-identus/cloud-agent/blob/main/shared/src/main/scala/io/iohk/atala/shared/models/Failure.scala).
396396
This allows handling "at the end of the world“ to be done in a consistent and in generic way.
397397

398398
Create an exhaustive and meaningful list of service errors and make sure the value of the `userFacingMessage` attribute
399399
is chosen wisely! It will present "as is" to the user and should not contain any sensitive
400-
data ([example](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L14)).
400+
data ([example](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L14)).
401401

402402
```scala
403403
trait Failure {
@@ -470,7 +470,7 @@ object ConnectionServiceError {
470470
#### Use Scala 3 Union Types
471471

472472
Use Scala 3 union-types declaration in the effect’s error channel to notify the caller of potential
473-
failures ([example](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/service/ConnectionServiceImpl.scala#L178))
473+
failures ([example](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/service/ConnectionServiceImpl.scala#L178))
474474

475475
````scala
476476
class ConnectionServiceImpl() extends ConnectionService {
@@ -490,9 +490,9 @@ The upper layer will automatically do so appropriately and consistently using Ta
490490
#### Reporting RFC-9457 Error Response
491491

492492
All declared Tapir endpoints must
493-
use [`org.hyperledger.identus.api.http.ErrorResponse`](https://github.com/hyperledger/identus-cloud-agent/blob/main/cloud-agent/service/server/src/main/scala/io/iohk/atala/api/http/ErrorResponse.scala)
493+
use [`org.hyperledger.identus.api.http.ErrorResponse`](https://github.com/hyperledger-identus/cloud-agent/blob/main/cloud-agent/service/server/src/main/scala/io/iohk/atala/api/http/ErrorResponse.scala)
494494
as their output error
495-
type ([example](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/cloud-agent/service/server/src/main/scala/io/iohk/atala/connect/controller/ConnectionEndpoints.scala#L45))
495+
type ([example](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/cloud-agent/service/server/src/main/scala/io/iohk/atala/connect/controller/ConnectionEndpoints.scala#L45))
496496
This type ensures that the response returned to the user complies with
497497
the [RFC-9457 Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457.html).
498498

@@ -514,10 +514,10 @@ object ConnectionEndpoints {
514514

515515
If all the underlying services used by a controller comply with the above rules, then the only error type that could
516516
propagate through the effect’s error channel is the
517-
parent [`org.hyperledger.identus.shared.models.Failure`](https://github.com/hyperledger/identus-cloud-agent/blob/main/shared/src/main/scala/io/iohk/atala/shared/models/Failure.scala)
517+
parent [`org.hyperledger.identus.shared.models.Failure`](https://github.com/hyperledger-identus/cloud-agent/blob/main/shared/src/main/scala/io/iohk/atala/shared/models/Failure.scala)
518518
type and its conversion
519519
to the ErrorResponse type is done automatically
520-
via [Scala implicit conversion](https://github.com/hyperledger/identus-cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/cloud-agent/service/server/src/main/scala/io/iohk/atala/api/http/ErrorResponse.scala#L44).
520+
via [Scala implicit conversion](https://github.com/hyperledger-identus/cloud-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/cloud-agent/service/server/src/main/scala/io/iohk/atala/api/http/ErrorResponse.scala#L44).
521521

522522
#### Do not reflexively log errors
523523

documentation/docs/identus/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ Identus is a toolset designed for Decentralized Identity enablement. These tools
88

99
* [Mediator](mediator): The Mediator acts as a bridge between the [holder's](/docs/concepts/glossary#holder) device and other actors, such as [issuers](/docs/concepts/glossary#issuer) and [verifiers](/docs/concepts/glossary#verifier), ensuring secure and reliable communication without centralized management​​​​.
1010

11-
* Edge Agent SDKs: allow the development of edge agents - Decentralized Identity mobile apps and browser extensions. The SDKs are available in [Swift](https://hyperledger.github.io/identus-edge-agent-sdk-swift/documentation/edgeagentsdk/) (iOS and other Apple OS), [TS](https://hyperledger.github.io/identus-docs/identus-edge-agent-sdk-ts/sdk) (Browser and Node.js), and [Kotlin Multiplatform](https://hyperledger.github.io/identus-edge-agent-sdk-kmp/) (JVM and Android)
11+
* Edge Agent SDKs: allow the development of edge agents - Decentralized Identity mobile apps and browser extensions. The SDKs are available in [Swift](https://hyperledger-identus.github.io/edge-agent-sdk-swift/documentation/edgeagentsdk/) (iOS and other Apple OS), [TS](https://hyperledger-identus.github.io/docs/edge-agent-sdk-ts/sdk) (Browser and Node.js), and [Kotlin Multiplatform](https://hyperledger-identus.github.io/edge-agent-sdk-kmp/) (JVM and Android)

docusaurus.config.js

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ const config = {
1212
title: 'Hyperledger Identus',
1313
tagline: 'Hyperledger Identus Docs',
1414
// url: 'https://docs.atalaprism.io',
15-
url: 'https://hyperledger.github.io/',
16-
baseUrl: '/identus-docs/',
17-
onBrokenLinks: 'throw',
15+
url: 'https://hyperledger-identus.github.io/',
16+
baseUrl: '/docs/',
17+
onBrokenLinks: 'ignore', //TODO: make this `throw` after migration
1818
onBrokenMarkdownLinks: 'warn',
1919
favicon: 'img/favicon.ico',
2020
organizationName: 'Hyperledger',
@@ -55,7 +55,7 @@ const config = {
5555
// Plugin Options for loading OpenAPI files
5656
specs: [
5757
{
58-
spec: 'identus-cloud-agent/cloud-agent/service/api/http/cloud-agent-openapi-spec.yaml',
58+
spec: 'cloud-agent/cloud-agent/service/api/http/cloud-agent-openapi-spec.yaml',
5959
route: '/agent-api/',
6060
}
6161
]
@@ -68,9 +68,9 @@ const config = {
6868
'@docusaurus/plugin-content-docs',
6969
{
7070
id: 'tutorials',
71-
path: 'identus-cloud-agent/docs/docusaurus',
71+
path: 'cloud-agent/docs/docusaurus',
7272
routeBasePath: 'tutorials',
73-
sidebarPath: require.resolve('./identus-cloud-agent/docs/docusaurus/sidebars.js'),
73+
sidebarPath: require.resolve('./cloud-agent/docs/docusaurus/sidebars.js'),
7474
},
7575
],
7676
[
@@ -86,10 +86,10 @@ const config = {
8686
[
8787
'@docusaurus/plugin-content-docs',
8888
{
89-
id: 'identus-edge-agent-sdk-ts',
90-
path: 'identus-edge-agent-sdk-ts/docs',
91-
routeBasePath: 'identus-edge-agent-sdk-ts',
92-
sidebarPath: require.resolve('./identus-edge-agent-sdk-ts/docs/sidebars.js'),
89+
id: 'edge-agent-sdk-ts',
90+
path: 'edge-agent-sdk-ts/docs',
91+
routeBasePath: 'edge-agent-sdk-ts',
92+
sidebarPath: require.resolve('./edge-agent-sdk-ts/docs/sidebars.js'),
9393
},
9494
]
9595
],
@@ -139,13 +139,13 @@ const config = {
139139
href: 'https://hyperledger.github.io/identus-edge-agent-sdk-swift/documentation/edgeagentsdk/',
140140
},
141141
{
142-
to: '/identus-edge-agent-sdk-ts/sdk',
142+
to: '/edge-agent-sdk-ts/sdk',
143143
label: 'Edge Agent SDK Typescript',
144-
activeBaseRegex: `/identus-edge-agent-sdk-ts/sdk`
144+
activeBaseRegex: `/edge-agent-sdk-ts/sdk`
145145
},
146146
{
147147
label: 'Edge Agent SDK Kotlin Multiplatform',
148-
href: 'https://hyperledger.github.io/identus-edge-agent-sdk-kmp/',
148+
href: 'https://hyperledger-identus.github.io/edge-agent-sdk-kmp/',
149149
},
150150
],
151151
},

src/components/resources/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ const RESOURCES = [
141141
title: "Wallet SDK KMM",
142142
Svg: Graphics.walletSdkKmm,
143143
content: "Build KMM-based applications using our SDKs",
144-
linkTo: "https://hyperledger.github.io/identus-edge-agent-sdk-kmp/"
144+
linkTo: "https://hyperledger-identus.github.io/edge-agent-sdk-kmp/"
145145
},
146146
{
147147
title: "APIs",

0 commit comments

Comments
 (0)