README
Using protocol-common
Protocol-common is a shared library of commonly used functions in protocol web services such as Aries-Guardianship-Agency.
Protocol-common is distributed through npm packages. Please use NPM package for your work.
Contributing to protocol-common
Getting Started
Typically you'll need to update this repo when you want to change code that's shared among multiple services.
- Create a branch named after the Jira ticket you're working on (e.g. PRO-2000)
- Make your code changes
- Update the "version" in package.json using Major.Minor.Patch semantic versioning
- Commit your change to the branch and create a new PR in github
- Once approved and merged CD will automatically create an npm package at the version number you specified
- (optional) Update repos that consume protocol-common.
notes
github info
npm package how-to
using experimental features in packages
Library Documentation
Config Module data format
To use the ConfigModule, data needs to be passed in. The data needs to be a specific format. This is an example of that format.
{
"default": {
"SERVICE_NAME": "authservice"
},
"local": {
"WALLET_SYNC_SERVICE_URL": "http://protocol-wallet-sync-service:3004",
"IDENTITY_SERVICE_URL": "http://protocol-identity-service:8080",
"IDENTITY_SERVICE_BACKEND": "ncratemplate",
"MAX_LOG_LENGTH": 5000,
"JAEGER_ENDPOINT": "http://jaeger:14268/api/traces",
"JWT_EXPIRE_SECONDS": 36000,
"TRACER": "",
"RESTFUL_CLIENT_DELAY": 250,
"RESTFUL_CLIENT_RETRY": 5
},
"dev": {},
"qa": {},
"sand": {},
"prod": {}
}