https://github.com/absaoss/vcxagencynode
NodeJS implementation of Hyperledger Indy LibVCX Agency
https://github.com/absaoss/vcxagencynode
hyperledger-aries hyperledger-indy libvcx
Last synced: 2 months ago
JSON representation
NodeJS implementation of Hyperledger Indy LibVCX Agency
- Host: GitHub
- URL: https://github.com/absaoss/vcxagencynode
- Owner: AbsaOSS
- License: apache-2.0
- Created: 2020-06-03T18:46:31.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-28T12:43:01.000Z (over 1 year ago)
- Last Synced: 2024-04-12T07:05:57.096Z (about 1 year ago)
- Topics: hyperledger-aries, hyperledger-indy, libvcx
- Language: JavaScript
- Homepage:
- Size: 3.46 MB
- Stars: 24
- Watchers: 10
- Forks: 9
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Decommission notice
This project has been decommissioned. No further updates or maintenance shall be expected.
# Node VCX Agency
- Implementation of [AriesVCX](https://github.com/hyperledger/aries-vcx/) compatible
[Mediator Agency](https://github.com/hyperledger/aries-rfcs/blob/master/concepts/0046-mediators-and-relays/README.md).
- Mediator Agency can service many users, providing them endpoint where 3rd parties can deliver encrypted messages.
Assuming the sending party has properly end2end encrypted the message for recipient, according to Aries connection
protocol, the agency itself can't decrypt content of received messages.
- VCX Agency implements 2 notification mechanisms.
1. Webhooks - The agency calls a specified url when an agent receives a message. This is useful when using
AriesVcx on a server.
2. Longpolls - Agent owners can poll agency to check whether any new messages have arrived. This is implemented via
longpoll mechanism - the server returns response only if a new message has arrived, or certain amount of time has
passed since the query request was received. This is to prevent overloading agency with client requests.
In the future, longpoll mechanism might be replaced by websockets.
# Repository structure
The agency implementation is in directory [vcxagency-node](./vcxagency-node).
Repository structure details:
```
/
├── dev/ # Monorepo management scripts
├── vcxagency-node / # AriesVCX mediator agency implementation in NodeJS
├── vcxagency-client/ # AriesVCX mediator agency client in NodeJS
├── easy-indysdk/ # NodeJS idiomatic wrapper around basic IndySDK wrapper
└-- vcx-tester/ # AriesVCX integration tests using AriesVCX
```
- Rust client for agency can be found [here](https://github.com/hyperledger/aries-vcx/tree/master/agency_client).
# Note
- Project is using `yarn` instead of `npm` to install dependencies in all modules. The reason is that
`npm` has issues handling monorepo projects with `file:` style dependencies.
See more info here https://github.com/npm/npm/issues/13528
---
Copyright 2020 ABSA Group Limited
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.