Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UML documentation added for smart contracts #33

Open
wants to merge 1 commit into
base: feature/newdoc
Choose a base branch
from
Open

UML documentation added for smart contracts #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 5 additions & 18 deletions contracts/ContractInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,7 @@
| Contract Name | Address | ABI |
| :------------ | :-------| :--- |
| AlastriaCredentialRegistry | 0x9f1b26710eff584f017507ad1a7424cc49f1b930 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_registry_AlastriaCredentialRegistry_sol_AlastriaCredentialRegistry.abi |
| AlastriaPublicKeyRegistry | 0x16e99506009a9bdcbc8546bc629c3d52d8f8264f | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_registry_AlastriaPublicKeyRegistry_sol_AlastriaPublicKeyRegistry.abi |
| AlastriaIdentityManager | 0xe9dc6bce74e1ee0ccd7aa461c0c7c3ea0014aa4c | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_identityManager_AlastriaIdentityManager_sol_AlastriaIdentityManager.abi |
| Eidas | 0x0682a91a56067e2ff44dd80c8dd18e3686a6b9a2 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_libs_Eidas_sol_Eidas.abi |
| AlastriaIdentityIssuer | 0x6dd3fab3903ec13fc4a8dfc4f0abc514bdd6cc10 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_identityManager_AlastriaIdentityIssuer_sol_AlastriaIdentityIssuer.abi |
| Owned | 0x9e2a69abfcee71f3126ddfb345c4f1898576a262 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_libs_Owned_sol_Owned.abi |
| AlastriaPresentationRegistry | 0x75d2d6505ce8f8c225d840da42dc33c8e8143501 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_registry_AlastriaPresentationRegistry_sol_AlastriaPresentationRegistry.abi |
| AlastriaProxy | 0x1b2d9c8cd59a3916af0a6ef2379f47bf7b410101 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_identityManager_AlastriaProxy_sol_AlastriaProxy.abi |
| AlastriaIdentityServiceProvider | 0x09fc73d0c18337a20602b1d3f1508e71b6361268 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_identityManager_AlastriaIdentityServiceProvider_sol_AlastriaIdentityServiceProvider.abi |
| AlastriaIdentityServiceProvider | 0x09fc73d0c18337a20602b1d3f1508e71b6361268 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_identityManager_AlastriaIdentityServiceProvider_sol_AlastriaIdentityServiceProvider.abi |
| AlastriaIdentityManager | 0xe9dc6bce74e1ee0ccd7aa461c0c7c3ea0014aa4c | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_identityManager_AlastriaIdentityManager_sol_AlastriaIdentityManager.abi |
| Eidas | 0x0682a91a56067e2ff44dd80c8dd18e3686a6b9a2 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_libs_Eidas_sol_Eidas.abi |
| AlastriaPublicKeyRegistry | 0x16e99506009a9bdcbc8546bc629c3d52d8f8264f | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_registry_AlastriaPublicKeyRegistry_sol_AlastriaPublicKeyRegistry.abi |
| Owned | 0x9e2a69abfcee71f3126ddfb345c4f1898576a262 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_libs_Owned_sol_Owned.abi |
| AlastriaPresentationRegistry | 0x75d2d6505ce8f8c225d840da42dc33c8e8143501 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_registry_AlastriaPresentationRegistry_sol_AlastriaPresentationRegistry.abi |
| AlastriaProxy | 0x1b2d9c8cd59a3916af0a6ef2379f47bf7b410101 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_identityManager_AlastriaProxy_sol_AlastriaProxy.abi |
| AlastriaCredentialRegistry | 0x9f1b26710eff584f017507ad1a7424cc49f1b930 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_registry_AlastriaCredentialRegistry_sol_AlastriaCredentialRegistry.abi |
| AlastriaIdentityIssuer | 0x6dd3fab3903ec13fc4a8dfc4f0abc514bdd6cc10 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/__contracts_identityManager_AlastriaIdentityIssuer_sol_AlastriaIdentityIssuer.abi |
| Eidas | 0x8f1f24abbc31f71f7833f146baee96d1dff6cf39 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/Eidas |
| AlastriaIdentityManager | 0x71e18c516483912c7730bdafb9e8b9aaca648aee | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/AlastriaIdentityManager |
| AlastriaCredentialRegistry | 0x07e3532daef5a6004f2e9bcc1da6cbc0fd2b6ed0 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/AlastriaCredentialRegistry |
| AlastriaPresentationRegistry | 0x5148b9f4f8f6caa2b81e282e7da6f22e6a5b85d3 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/AlastriaPresentationRegistry |
| AlastriaPublicKeyRegistry | 0x99101da661e3f498677ca647f60f4073127c52c0 | https://github.com/alastria/alastria-identity/blob/develop/contracts/abi/AlastriaPublicKeyRegistry |
62 changes: 62 additions & 0 deletions contracts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@

# Smart Contracts Documentation

```
Last update @ 6/11/2019
```

### 1. Identity Manager
|Contract | What it does |
| :------------- |:-------------|
| AlastriaIdentityManager.sol |It generates access tokens, creates identities, deploys an AlastriaProxy for each identity and sends transactions through the proxy of the sender|
![AlastriaIdentityManager.sol](./uml/identityManager/AlastriaIdentityManager.svg)

|Contract | What it does |
| :------------- |:-------------|
| AlastriaProxy.sol | It is the Alastria ID itself. Only receives transactions from the IdentityManager and resends them to the target |
![AlastriaProxy.sol](./uml/identityManager/AlastriaProxy.svg)

|Contract | What it does |
| :------------- |:-------------|
| AlastriaIdentityIssuer.sol | It keeps a registry of the issuers identities |
![AlastriaIdentityIssuer.sol](./uml/identityManager/AlastriaIdentityIssuer.svg)

|Contract | What it does |
| :------------- |:-------------|
| AlastriaIdentityServiceProvider.sol |It keeps a registry of the service providers identities |
![AlastriaIdentityServiceProvider.sol](./uml/identityManager/AlastriaIdentityServiceProvider.svg)


### 2. Registry
|Contract | What it does |
|:------------- |:-------------|
| AlastriaCredentialRegistry.sol |It manages all the credentials and keeps the registry and the status |
![AlastriaCredentialRegistry.sol](./uml/registry/AlastriaCredentialRegistry.svg)

|Contract | What it does |
|:------------- |:-------------|
| AlastriaPresentationRegistry.sol |It manages all the presentations and keeps the registry and the status |
![AlastriaPresentationRegistry.sol](./uml/registry/AlastriaPresentationRegistry.svg)

|Contract | What it does |
|:------------- |:-------------|
| AlastriaPublicKeyRegistry.sol | It manages all the public keys and keeps the registry |
![AlastriaPublicKeyRegistry.sol](./uml/registry/AlastriaPublicKeyRegistry.svg)

### 3. Libs
The previous contracts use some libraries which are:

| Contract | What it does |
|:------------- |:-------------|
| Eidas.sol | It manages Eidas level of assurance for credentials|
![Eidas.sol](./uml/libs/Eidas.sol.svg)

| Contract | What it does |
|:------------- |:-------------|
| Owned.sol | It assures that just the account which deployed a contract can update the version |
![Owned.sol](./uml/libs/Owned.sol.svg)


## Need Help?
Our identity core team will be happy to listen to you at [slack #identidaddigital](https://github.com/alastria/alastria-node/wiki/HELP)

48 changes: 48 additions & 0 deletions contracts/uml/identityManager/AlastriaIdentityIssuer.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions contracts/uml/identityManager/AlastriaIdentityManager.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions contracts/uml/identityManager/AlastriaIdentityServiceProvider.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading