- Notifications
You must be signed in to change notification settings - Fork9
NodeJS implementation of Hyperledger Indy LibVCX Agency
License
NotificationsYou must be signed in to change notification settings
AbsaOSS/vcxagencynode
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
This project has been decommissioned. No further updates or maintenance shall be expected.
Implementation ofAriesVCX compatibleMediator Agency.
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.
- Webhooks - The agency calls a specified url when an agent receives a message. This is useful when usingAriesVcx on a server.
- Longpolls - Agent owners can poll agency to check whether any new messages have arrived. This is implemented vialongpoll mechanism - the server returns response only if a new message has arrived, or certain amount of time haspassed 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.
The agency implementation is in directoryvcxagency-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 foundhere.
- Project is using
yarn
instead ofnpm
to install dependencies in all modules. The reason is thatnpm
has issues handling monorepo projects withfile:
style dependencies.See more info herenpm/npm#13528
Copyright 2020 ABSA Group Limitedyou 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.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.
About
NodeJS implementation of Hyperledger Indy LibVCX Agency