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.

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

docs: using postgres storage #824

Merged
merged 40 commits into from Jun 3, 2022
Merged

docs: using postgres storage #824

merged 40 commits into from Jun 3, 2022

Conversation

ghost
Copy link

@ghost ghost commented Jun 1, 2022

Added documentation for usage and setup of Postgres plugin setup

  • Linux
  • Mac
  • Windows (Not able to build Postgres plugin on windows yet, getting an error regarding libsodium-sys 0.0.16 )

#758 #771

@ghost ghost self-requested a review as a code owner June 1, 2022 13:37
sairanjit and others added 28 commits June 1, 2022 19:13
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Mike Richardson <mike.richardson@northernblock.io>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Jakub Koci <jakub.koci@gmail.com>
Co-authored-by: Timo Glastra <timo@animo.id>

BREAKING CHANGE: the connections module has been extended with an out of band module and support for the DID Exchange protocol. Some methods have been moved to the out of band module, see [Migrating from AFJ 0.1.0 to 0.2.x](https://github.com/hyperledger/aries-framework-javascript/blob/main/docs/migration/0.1-to-0.2.md) for detailed migration instructions.

Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Blazej Marcinkiewicz <marcinkiewicz@procivis.ch>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
feat: extension module creation (#688)

Co-authored-by: Berend Sliedrecht <berend@animo.id>
Co-authored-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Mike Richardson <mike.richardson@northernblock.io>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Mike Richardson <mike.richardson@northernblock.io>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Karim <karim@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Mike Richardson <mike.richardson@northernblock.io>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>

BREAKING CHANGE: with the addition of the out of band module `credentials.createOutOfBandOffer` is renamed to `credentials.createOffer` and no longer adds the `~service` decorator to the message. You need to call `oob.createLegacyConnectionlessInvitation` afterwards to use it for AIP-1 style connectionless exchanges. See [Migrating from AFJ 0.1.0 to 0.2.x](https://github.com/hyperledger/aries-framework-javascript/blob/main/docs/migration/0.1-to-0.2.md) for detailed migration instructions.

Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Berend Sliedrecht <berend@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Amit-Padmani <amit.padmani@ontario.ca>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: KolbyRKunz <KolbyKunz@yahoo.com>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
…#798)

Signed-off-by: Mike Richardson <mike.richardson@ontario.ca>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Berend Sliedrecht <berend@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
NB-MikeRichardson and others added 10 commits June 1, 2022 19:13
Signed-off-by: Mike Richardson <mike.richardson@ontario.ca>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Mike Richardson <mike.richardson@ontario.ca>

BREAKING CHANGE: the credentials associated with a credential exchange record are now deleted by default when deleting a credential exchange record. If you only want to delete the credential exchange record and not the associated credentials, you can pass the deleteAssociatedCredentials to the deleteById method:

```ts
await agent.credentials.deleteById('credentialExchangeId', {
	deleteAssociatedCredentials: false
})
```

Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Berend Sliedrecht <berend@animo.id>

Co-authored-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Timo Glastra <timo@animo.id>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Mike Richardson <mike.richardson@ontario.ca>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Mike Richardson <mike.richardson@ontario.ca>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Mostafa Gamal <46829557+MosCD3@users.noreply.github.com>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
Signed-off-by: Sai Ranjit Tummalapalli <sairanjit.tummalapalli@ayanworks.com>
@codecov-commenter
Copy link

codecov-commenter commented Jun 1, 2022

Codecov Report

Merging #824 (269cf66) into main (8dd7f80) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #824   +/-   ##
=======================================
  Coverage   87.69%   87.69%           
=======================================
  Files         438      438           
  Lines       10820    10820           
  Branches     1891     1891           
=======================================
  Hits         9489     9489           
  Misses       1269     1269           
  Partials       62       62           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8dd7f80...269cf66. Read the comment docs.

Copy link
Contributor

@TimoGlastra TimoGlastra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@blu3beri can you review this PR and see how we can integrate this with the new documentation site?

@berendsliedrecht
Copy link
Contributor

I think it good to merge it. I will most like change some minor parts when integrating it into the new documentation website but for now this will suffice. Thanks for the PR @sairanjitAW

@berendsliedrecht
Copy link
Contributor

@sairanjitAW do you think that Windows will be done soon? I think merging it after that might be the best.

@ghost
Copy link
Author

ghost commented Jun 2, 2022

@blu3beri I'm working on it, but it will take some time.
Still stuck in building libsodium-sys-0.0.16 on windows.

@TimoGlastra
Copy link
Contributor

In that case maybe we can already merge it? As postgres support has already been merged this seems quite useful

@berendsliedrecht berendsliedrecht enabled auto-merge (squash) June 3, 2022 10:31
@berendsliedrecht berendsliedrecht merged commit a717a58 into openwallet-foundation:main Jun 3, 2022
@ghost ghost deleted the docs/using-postgres-storage branch June 3, 2022 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.